joepie91/pegjs
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
pegjs/spec/README.md

50 lines
1 KiB
Markdown
Raw Normal View History

Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
PEG.js Spec Suite
=================
This is the PEG.js spec suite. It ensures PEG.js works correctly. All specs
should always pass on all supported platforms.
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
Running in Node.js
------------------
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
All commands in the following steps need to be executed in PEG.js root directory
(one level up from this one).
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
1. Install all PEG.js dependencies, including development ones:
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Add syntax highlighting to code blocks in README.md files
2016-05-05 10:15:28 +02:00
```console
$ npm install
```
Git repo npmization: Make the repo a npm package Includes: * Moving the source code from /src to /lib. * Adding an explicit file list to package.json * Updating the Makefile. * Updating the spec and benchmark suites and their READMEs. Part of a fix for GH-32.
2012-11-10 14:21:14 +01:00
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
2. Execute the spec suite:
Git repo npmization: Make the repo a npm package Includes: * Moving the source code from /src to /lib. * Adding an explicit file list to package.json * Updating the Makefile. * Updating the spec and benchmark suites and their READMEs. Part of a fix for GH-32.
2012-11-10 14:21:14 +01:00
Add syntax highlighting to code blocks in README.md files
2016-05-05 10:15:28 +02:00
```console
$ make spec
```
Git repo npmization: Make the repo a npm package Includes: * Moving the source code from /src to /lib. * Adding an explicit file list to package.json * Updating the Makefile. * Updating the spec and benchmark suites and their READMEs. Part of a fix for GH-32.
2012-11-10 14:21:14 +01:00
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
3. Watch the specs pass (or fail).
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Use sentence case consistently in {spec,benchmark}/README.md headers
2014-05-10 16:40:39 +02:00
Running in the Browser
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
----------------------
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
All commands in the following steps need to be executed in PEG.js root directory
(one level up from this one).
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Use http-server to serve specs and benchmarks to the browser Previously, the instructions recommended using Python's SimpleHTTPServer module, which created unnecessary dependency on Python.
2016-05-05 17:35:40 +02:00
1. Make sure you have Node.js installed.
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
2. Install all PEG.js dependencies, including development ones:
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Add syntax highlighting to code blocks in README.md files
2016-05-05 10:15:28 +02:00
```console
$ npm install
```
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Pass spec code through Babel before serving it to the browser This will allow to use ES2015 constructs in spec code. The change required introducing a small server, which serves both PEG.js and spec code passed through Babel and bundled together. This allowed to convert the specs to regular modules and get rid of the hackery that was previously needed to make them run both in Node.js and in the browser. Note the specs no longer exercise the browser version. This will allow to spec PEG.js internals in the future. See #442.
2016-09-08 13:29:06 +02:00
3. Serve the spec suite using a web server:
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Add syntax highlighting to code blocks in README.md files
2016-05-05 10:15:28 +02:00
```console
Pass spec code through Babel before serving it to the browser This will allow to use ES2015 constructs in spec code. The change required introducing a small server, which serves both PEG.js and spec code passed through Babel and bundled together. This allowed to convert the specs to regular modules and get rid of the hackery that was previously needed to make them run both in Node.js and in the browser. Note the specs no longer exercise the browser version. This will allow to spec PEG.js internals in the future. See #442.
2016-09-08 13:29:06 +02:00
$ spec/server
Add syntax highlighting to code blocks in README.md files
2016-05-05 10:15:28 +02:00
```
Jasmine: Initial infrastructure This is the first of many commits that gradually convert PEG.js's test suite from QUnit to Jasmine, cleaning it up on the way. Main reason for the change is that Jasmine allows nested contexts, allowing to structure the tests in a better way than QUnit. Moreover, the tests needed to be cleaned up a bit.
2012-02-27 19:59:54 +01:00
Pass spec code through Babel before serving it to the browser This will allow to use ES2015 constructs in spec code. The change required introducing a small server, which serves both PEG.js and spec code passed through Babel and bundled together. This allowed to convert the specs to regular modules and get rid of the hackery that was previously needed to make them run both in Node.js and in the browser. Note the specs no longer exercise the browser version. This will allow to spec PEG.js internals in the future. See #442.
2016-09-08 13:29:06 +02:00
4. Point your browser to the [spec suite](http://localhost:8000/).
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
Pass spec code through Babel before serving it to the browser This will allow to use ES2015 constructs in spec code. The change required introducing a small server, which serves both PEG.js and spec code passed through Babel and bundled together. This allowed to convert the specs to regular modules and get rid of the hackery that was previously needed to make them run both in Node.js and in the browser. Note the specs no longer exercise the browser version. This will allow to spec PEG.js internals in the future. See #442.
2016-09-08 13:29:06 +02:00
5. Watch the specs pass (or fail).
Reference in a new issue Copy permalink