Set up code style linting with standardjs

ccj7373 · Aug 28, 2019 · a5d6b8a · a5d6b8a
1 parent 8e2a7de
commit a5d6b8a
Show file tree

Hide file tree

Showing 43 changed files with 7,977 additions and 6,988 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,3 +1,10 @@
 language: node_js
 node_js:
   - "lts/*"
+
+jobs:
+  include:
+    - name: Lint
+      stage: other
+      script: npm run lint
+      node_js: lts/*
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,10 +6,18 @@ up with ideas and suggestions, and contribute to the code.
 
 There are a few preferences regarding code contributions:
 
-- `jsoneditor` follows the node.js code style as described
-  [here](http://nodeguide.com/style.html).
-- Send pull requests to the `develop` branch, not the `master` branch.
-- Only commit changes done in the source files under `./src`, not to the builds
-  which are located under the `./dist` folder.
+-   Send pull requests to the `develop` branch, not the `master` branch.
+-   You can use modern JavaScript features, the code is transpiled using Babel.
+-   `jsoneditor` follows the https://standardjs.com/ code style. To test:
+
+    ```
+    npm run lint
+    ```
+
+-   If possible, create a unit test for any new functionality. To run tests:
+
+    ```
+    npm test
+    ```
 
 Thanks!
diff --git a/README.md b/README.md
@@ -96,9 +96,9 @@ with npm (recommended):
 
     <script>
         // create the editor
-        var container = document.getElementById("jsoneditor");
-        var options = {};
-        var editor = new JSONEditor(container, options);
+        var container = document.getElementById("jsoneditor")
+        var options = {}
+        var editor = new JSONEditor(container, options)
 
         // set json
         var json = {
@@ -108,11 +108,11 @@ with npm (recommended):
             "Number": 123,
             "Object": {"a": "b", "c": "d"},
             "String": "Hello World"
-        };
-        editor.set(json);
+        }
+        editor.set(json)
 
         // get json
-        var json = editor.get();
+        var json = editor.get()
     </script>
 </body>
 </html>

diff --git a/examples/requirejs_demo/requirejs_demo.html b/examples/requirejs_demo/requirejs_demo.html
@@ -9,7 +9,7 @@
     }
   </style>
   <link rel="stylesheet" type="text/css" href="../../dist/jsoneditor.css">
-  <script data-main="scripts/main" src="scripts/require.js"></script>
+  <script data-main="scripts/main" src="https://requirejs.org/docs/release/2.3.6/minified/require.js"></script>
 </head>
 <body>
 <p>

diff --git a/examples/requirejs_demo/scripts/main.js b/examples/requirejs_demo/scripts/main.js
@@ -1,25 +1,25 @@
-var module = '../../../dist/jsoneditor';
+var module = '../../../dist/jsoneditor'
 require([module], function (JSONEditor) {
   // create the editor
-  var container = document.getElementById('jsoneditor');
-  var editor = new JSONEditor(container);
+  var container = document.getElementById('jsoneditor')
+  var editor = new JSONEditor(container)
 
   // set json
   document.getElementById('setJSON').onclick = function () {
     var json = {
-      'array': [1, 2, 3],
-      'boolean': true,
-      'null': null,
-      'number': 123,
-      'object': {'a': 'b', 'c': 'd'},
-      'string': 'Hello World'
-    };
-    editor.set(json);
-  };
+      array: [1, 2, 3],
+      boolean: true,
+      null: null,
+      number: 123,
+      object: { a: 'b', c: 'd' },
+      string: 'Hello World'
+    }
+    editor.set(json)
+  }
 
   // get json
   document.getElementById('getJSON').onclick = function () {
-    var json = editor.get();
-    alert(JSON.stringify(json, null, 2));
-  };
-});
+    var json = editor.get()
+    window.alert(JSON.stringify(json, null, 2))
+  }
+})
diff --git a/examples/requirejs_demo/scripts/require.js b/examples/requirejs_demo/scripts/require.js