mediawiki-extensions-Visual.../tests/parser/README

Work in progress. :)

Please see https://www.mediawiki.org/wiki/Future/Parser_development for some
information on how to get started with these tests and the current parser
architecture.

Needed npm modules:
* pegjs
* colors
* html5
* jquery
* jsdom
* diff
* libxmljs (requires native compilation)
* optimist (for argument handling)
* webworker (not needed for parserTests)
* coffee-script (if you'd like to modify .coffee files)

== Running parserTests.js ==

For parserTests, you also need MediaWiki's parser test cases (parserTests.txt)
either in a phase3 checkout parallel to extensions (tried by default). You can
also specify a test case file as an argument.

The "make test" target in this directory downloads parserTests.txt and specifies
it as the test case automatically.  Of course, you may also run tests manually:

node ./parserTests.js

Several options are available for parserTests:

node ./parserTests.js --help

Enjoy!

== Running roundtrip tests ==

Round-trip tests are not yet ported to the current parser architecture. The
focus so far has been on parserTests and getting the parser architecture in
shape, but we'll get back to round-trip tests eventually.
First combination of WikiDom serializers with existing parser in tests/parser/parserTests.js. * Removed var from es in es.js to allow node.js to access it as global. Only alternative solution appears to be a node-specific 'exports' construct: http://nodejs.org/docs/v0.3.1/api/modules.html * Added es.Document.js and es.Document.Serializer.js in es/bases. Not sure if this is the desired location. * Changed es.extend to es.extendClass in the serializers * Modified the first parser test to include the WikiDom modules and call the new HTML serializer 2011-11-03 13:55:48 +00:00			`Work in progress. :)`

Update README 2011-12-13 10:03:01 +00:00			`Please see https://www.mediawiki.org/wiki/Future/Parser_development for some`
Follow-up to r106001: Fix typo spotted by Nikerabbit. Good catch! 2011-12-13 13:00:57 +00:00			`information on how to get started with these tests and the current parser`
Update README 2011-12-13 10:03:01 +00:00			`architecture.`
First combination of WikiDom serializers with existing parser in tests/parser/parserTests.js. * Removed var from es in es.js to allow node.js to access it as global. Only alternative solution appears to be a node-specific 'exports' construct: http://nodejs.org/docs/v0.3.1/api/modules.html * Added es.Document.js and es.Document.Serializer.js in es/bases. Not sure if this is the desired location. * Changed es.extend to es.extendClass in the serializers * Modified the first parser test to include the WikiDom modules and call the new HTML serializer 2011-11-03 13:55:48 +00:00
Update README 2011-12-13 10:03:01 +00:00			`Needed npm modules:`
Use pegjs from npm 2011-12-01 15:23:23 +00:00			`* pegjs`
add colors to visual editor parser testing TODO: add an option to switch color scheme for light/dark backgrounds 2011-11-30 15:20:46 +00:00			`* colors`
list some more needed node module 2011-11-28 11:40:14 +00:00			`* html5`
First combination of WikiDom serializers with existing parser in tests/parser/parserTests.js. * Removed var from es in es.js to allow node.js to access it as global. Only alternative solution appears to be a node-specific 'exports' construct: http://nodejs.org/docs/v0.3.1/api/modules.html * Added es.Document.js and es.Document.Serializer.js in es/bases. Not sure if this is the desired location. * Changed es.extend to es.extendClass in the serializers * Modified the first parser test to include the WikiDom modules and call the new HTML serializer 2011-11-03 13:55:48 +00:00			`* jquery`
list some more needed node module 2011-11-28 11:40:14 +00:00			`* jsdom`
First combination of WikiDom serializers with existing parser in tests/parser/parserTests.js. * Removed var from es in es.js to allow node.js to access it as global. Only alternative solution appears to be a node-specific 'exports' construct: http://nodejs.org/docs/v0.3.1/api/modules.html * Added es.Document.js and es.Document.Serializer.js in es/bases. Not sure if this is the desired location. * Changed es.extend to es.extendClass in the serializers * Modified the first parser test to include the WikiDom modules and call the new HTML serializer 2011-11-03 13:55:48 +00:00			`* diff`
			`* libxmljs (requires native compilation)`
proper argument handling (requires 'optimist' module) Handle arguments and options properly by using the 'optimist' node module. Please note wordwrapping in usage does not seem to work on my setup :( Only --help implemented yet. Example: $ node parserTests.js --help Starting up JS parser tests Usage: node ./parserTests.js Options: --filter, --regex Only run tests whose descriptions which match given regex (option not implemented) --help, -h Show this help message --disabled Run disabled tests (default false) (option not implemented) [boolean] 2011-11-30 16:33:26 +00:00			`* optimist (for argument handling)`
Update README 2011-12-13 10:03:01 +00:00			`* webworker (not needed for parserTests)`
* Convert __patched-html-parser to .coffee. Note that the compiled .js file (generated by "make"/"make test") is still under version control so folks can work on the project even without a running "coffee" command in PATH. Also updated README to mention coffee-script and "make test". 2012-02-18 18:54:12 +00:00			`* coffee-script (if you'd like to modify .coffee files)`
Update README 2011-12-13 10:03:01 +00:00
			`== Running parserTests.js ==`

			`For parserTests, you also need MediaWiki's parser test cases (parserTests.txt)`
			`either in a phase3 checkout parallel to extensions (tried by default). You can`
			`also specify a test case file as an argument.`

* Convert __patched-html-parser to .coffee. Note that the compiled .js file (generated by "make"/"make test") is still under version control so folks can work on the project even without a running "coffee" command in PATH. Also updated README to mention coffee-script and "make test". 2012-02-18 18:54:12 +00:00			`The "make test" target in this directory downloads parserTests.txt and specifies`
			`it as the test case automatically. Of course, you may also run tests manually:`
Update README 2011-12-13 10:03:01 +00:00
			`node ./parserTests.js`

			`Several options are available for parserTests:`

			`node ./parserTests.js --help`

			`Enjoy!`

			`== Running roundtrip tests ==`

			`Round-trip tests are not yet ported to the current parser architecture. The`
			`focus so far has been on parserTests and getting the parser architecture in`
			`shape, but we'll get back to round-trip tests eventually.`