@json-editor/json-editor 1.3.5 → 1.17.0

package/CONTRIBUTING.md

@@ -1,5 +1,15 @@
 Contributing
 ===============
+
+> **Note: This project is in maintenance mode**
+> 
+> JSON Editor is now in maintenance mode. We continue to accept and review community pull requests for:
+> - Bug fixes
+> - Security updates
+> - Critical improvements
+> 
+> For those seeking active development and new features, consider [Jedison](https://github.com/germanbisurgi/jedison).
+
 This document briefly lists the guidelines for contributing to JSON Editor.
 
 Reporting Bugs
@@ -9,7 +19,7 @@ When creating an issue in GitHub, try to include when feasible:
 *  An example JSON schema that causes the issue
 *  Steps to reproduce
 
-If you can reproduce the issue on the demo page (http://rawgithub.com/json-editor/json-editor/master/docs/demo.html), it's helpful to attach the "Direct Link" url (top right of page).  Note: the direct link might not work for very large schemas or JSON values.
+If you can reproduce the issue on the demo page (https://json-editor.github.io/json-editor/), it's helpful to attach the "Direct Link" url (top right of page).  Note: the direct link might not work for very large schemas or JSON values.
 
 if your setup is more complex (i.e. setting values using JavaScript interface), you can create a test setup at sites like  https://jsfiddle.net or https://codepen.io/.
 
@@ -23,16 +33,45 @@ If you fix a bug or add a cool feature, please submit a pull request!
 
 ### Code Style
 
+We use the [standardjs](https://standardjs.com/) standard style, enforced by [ESLint](https://eslint.org/).
+
+Also:
+
 *  Use 2 spaces for indentation
 *  Use comments whenever the code's meaning is not obvious
 *  When in doubt, try to match the style in existing source files
 
-### Grunt
+To check for errors without building:
+```bash
+npm run eslint
+```
+
+To automatically fix errors without building:
+```bash
+npm run eslint.fix
+```
+
+If you absolutely *must* break a style rule you can disable a rule for the next line with a comment of the following form:
+```javascript
+// eslint-disable-line rule-name
+```
+
+[ESLint integrations](https://eslint.org/docs/user-guide/integrations) are provided for most IDEs. They will normally provide  highlighting of errors and suggestions for fixes.
+
+### Development
+
+The easiest way to hack on JSON Editor is to run `npm run debug`, which 
+re-builds `dist/jsoneditor.js` every time a source file changes and serves the repo to a
+development server on port 8080, so you can load test pages such as (http://localhost:8080/tests/pages/array-selectize.html) and immmediately view and debug the results.
+
+Similarly, you can run and view the results of unit tests every time code changes by running `npm test`.
+
+To do a production build which includes eslint and minification, run `npm build`.
 
-The easiest way to hack on JSON Editor is to run `grunt watch`, which 
-re-builds `dist/jsoneditor.js` every time a source file changes.
+We encourage you to use a [BDD](https://en.wikipedia.org/wiki/Behavior-driven_development) and [TDD](https://en.wikipedia.org/wiki/Test-driven_development) approach to developing features and fixing bugs, in each case:
 
-To do a full grunt build which includes jshint and minification, run `grunt`.
+1. Writing end-to-end tests for your new features (`./tests/codeceptjs`)
+1. Write unit tests for edits to specify and confirm correct operation of small units of code such as functions and methods (`./tests/unit`)
 
 ### Submitting Pull Requests
 Try to limit pull requests to a single narrow feature or bug fix.

package/Makefile

@@ -0,0 +1,26 @@
+.PHONY=up clean bash test browser
+
+DOCKER_HOST?=localhost
+
+up:
+	docker-compose up -d
+
+clean:
+	docker-compose down --remove-orphans
+
+bash:
+	docker-compose exec node bash
+
+test:
+	docker-compose run --rm -w /repo/tests/codeceptjs node /repo/node_modules/.bin/codeceptjs run
+
+selenium-firefox:
+	xdg-open vnc://$(DOCKER_HOST):9059
+
+selenium-chrome:
+	xdg-open vnc://$(DOCKER_HOST):9060
+
+browser:
+	xdg-open http://$(DOCKER_HOST):9100
+
+open: browser