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

50 lines
1 KiB
Markdown
Raw Normal View History

Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
PEG.js Test Suite
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 "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
This is the PEG.js test suite. It ensures PEG.js works correctly. All tests
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
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
Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
2. Execute the test 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
Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
$ gulp test
Add syntax highlighting to code blocks in README.md files
2016-05-05 10:15:28 +02:00
```
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
Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
3. Watch the tests 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
Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
3. Serve the test 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
Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
$ test/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
Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
4. Point your browser to the [test suite](http://localhost:8000/).
Rewrite spec/README.md More clarity, better grammar (hopefully).
2014-05-09 15:04:56 +02:00
Use "test" and "tests" instead of "spec" and "specs" This reflects a convention used in most JavaScript projects. The change involves renaming the "spec" directory, Gulp task, etc.
2016-12-08 10:05:17 +01:00
5. Watch the tests pass (or fail).
Reference in a new issue Copy permalink