EnlighterJS is OpenSource and managed on GitHub - if you like, you're welcome to contribute! To simplify the release and quality control process, please follow these remarks:
- Your commits/pull-request should only contain changes of the
Source/
,Resources/TestcaseData
directories or the Examples located into the root directory - otherwise i have to merge the request manually - Do not change the files located into the
Examples/
orBuild/
directory - they are automatically generated during the build-process using data fromResources/TestcaseData
- Related software packages like MooTools, Bootstrap, ANT-contrib are updated by the maintainer
- If you form a concept of larger project changes, please discuss them with the contributors before implementing
- To change contents of the
README.md
file please edit the split files inDocs/
- the readme file is automatically generated by merging these files during the build process
- First of all: take a look on other languages which are already available to learn about functions and coding styles
- To start with a new language please use the
LanguageDevelopment.phtml
workspace. It will automatically loadSource/Language/Template.mylang.js
(the startup file for your language development). - Rename your language file
Template.mylang.js
to the camel-cased real language name - e.g.Vhdl.js
- Add detailed comments to each language rule!
- Keep the code as small as possible: e.g. use regex instead of long keyword lists
- In case your language is a superset of another one, please extend the origin language - do not copy the origin file
- Add an language testcase/demo to the
Resouces/TestcaseData
directory - Finally create a Pull Request on GitHub - your changes will be reviewed and commonly added to the project