library-mirrors/moonscript
1
0
Fork 0
mirror of https://github.com/leafo/moonscript.git synced 2024-12-08 01:54:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

start a spec writing guide

Browse Source
This commit is contained in:
leaf corcoran 2015-09-26 19:42:28 -07:00
parent 6082a86b11
commit c451418282
2 changed files with 60 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -24,6 +24,8 @@ To run tests, execute from the root directory:
busted
```
Writing specs is a bit more complicated. Check out [the spec writing guide](spec/README.md).
## License (MIT)
Copyright (C) 2015 by Leaf Corcoran

58
spec/README.md Normal file
View File

@ -0,0 +1,58 @@
# MoonScript Spec guide
Because MoonScript is written in MoonScript, and MoonScript specs are written
in MoonScript, you need to be aware of which copy of MoonScript is actually
executing the specs.
A system installed version of MoonScript is recommended to run the specs (and
for development). This means that you'll typically have two versions of
MoonScript available in the load path:
* The system version
* The version in the current directory
> A system install is recommended because you'll always want a functioning
> version of MoonScript to compile with in case you break your development
> version.
When developing you want to make ensure the tests are executing your changes in
the current directory, and not testing the system install.
Code running in Busted will have the system install take precedence over the
loaded version. That means that if you `require "moonscript.base"` for a test,
you won't get the local copy.
The `with_dev` spec helper will ensure that any require calls within the spec
that ask for MoonScript modules. `with_dev` calls a setup and teardown that
replaces `_G.require` with a custom version.
You'll use it like this:
```moonscript
import with_dev from require "spec.helpers"
describe "moonscript.base", ->
local moonscript
with_dev!
it "should load code", ->
-- the local version is loaded
moonscript = require "moonscript"
moonscript.load "print 12"
```
`with_dev`'s require function will load the `.lua` files in the local
directory, not the `moon` ones. You're responsible for compiling them first
before running the tests.
You might do
```bash
$ make compile_system; busted
```
> `make compile_system` is a makefile task included in the repo that will build
> MoonScript in the current directory with the version installed to the system