Merge pull request #50 from CesiumGS/tooling

Add prettier and eslint for consistent code

.eslintignore

@@ -0,0 +1 @@
+dist/**

.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "root": true,
+  "extends": ["cesium/node"]
+}

.github/workflows/main.yml

@@ -5,16 +5,19 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ 16, 18 ]
+        node: [18, 20]
     name: Node ${{ matrix.node }}
     steps:
       - uses: actions/checkout@v3
       - name: install node ${{ matrix.node }}
         uses: actions/setup-node@v3
         with:
-           node-version: ${{ matrix.node }}
+          node-version: ${{ matrix.node }}
       - name: install
         run: npm install
+      - name: lint *.js
+        run: npm run eslint
+      - name: format code
+        run: npm run prettier-check
       - name: build
         run: npm run build
-

.gitignore

@@ -1,4 +1,5 @@
 /dist/
 /node_modules/
 package-lock.json
-.DS_Store
+.DS_Store
+.eslintcache

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.npmignore

@@ -0,0 +1 @@
+webpack.config.js

.prettierignore

@@ -0,0 +1,15 @@
+
+# Ignore everything
+*
+
+# Unignore directories (to all depths) and unignore code and style files in these directories
+!.github/**/
+!.vscode/**/
+!src/**/
+!doc/**/
+
+!**/*.js
+!**/*.css
+!**/*.html
+!**/*.md
+!**/*.json

.prettierrc

@@ -0,0 +1 @@
+{}

README.md

@@ -6,62 +6,66 @@ A minimal recommended setup for an applications using [Cesium](https://cesium.co
 
 ## Running this application
 
-````sh
+```sh
 npm install
 npm start
-````
+```
 
 Navigate to `localhost:8080`.
 
 ### Available scripts
 
-* `npm start` - Runs a webpack build with `webpack.config.js` and starts a development server
-* `npm run build` - Runs a webpack build with `webpack.config.js`
+- `npm start` - Runs a webpack build with `webpack.config.js` and starts a development server
+- `npm run build` - Runs a webpack build with `webpack.config.js`
 
 ## Requiring Cesium in your application
 
 We recommend [importing named exports](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) from the Cesium ES module, via the `import` keyword. This allows webpack to [tree shake](https://webpack.js.org/guides/tree-shaking/) your application automatically.
 
 ### Import named modules from Cesium
 
-````js
-import { Color } from 'cesium';
+```js
+import { Color } from "cesium";
 var c = Color.fromRandom();
-````
+```
 
 ### Import Cesium static asset files
 
-````js
+```js
 import "cesium/Build/Cesium/Widgets/widgets.css";
-````
+```
 
 ## Removing pragmas
 
 To remove pragmas such as a traditional Cesium release build, use the [`strip-pragma-loader`](https://www.npmjs.com/package/strip-pragma-loader).
 
 Install the plugin with npm,
 
-````sh
+```sh
 npm install strip-pragma-loader --save-dev
-````
+```
 
 and include the loader in `module.rules` with `debug` set to `false`.
 
-````js
-rules: [{
-	test: /\.js$/,
-	enforce: 'pre',
-	include: path.resolve(__dirname, cesiumSource),
-	use: [{
-		loader: 'strip-pragma-loader',
-		options: {
-		    pragmas: {
-				debug: false
-			}
-		}
-	}]
-}]
-````
+```js
+rules: [
+  {
+    test: /\.js$/,
+    enforce: "pre",
+    include: path.resolve(__dirname, cesiumSource),
+    use: [
+      {
+        loader: "strip-pragma-loader",
+        options: {
+          pragmas: {
+            debug: false,
+          },
+        },
+      },
+    ],
+  },
+];
+```
 
 ## Contributions