diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..5d47c21 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.eslintrc.json b/.eslintrc.json new file mode 100644 index 0000000..5994d5d --- /dev/null +++ b/.eslintrc.json @@ -0,0 +1,33 @@ +{ + "env": { + "node": true, + "browser": true, + "es2021": true + }, + "extends": [ + "eslint:recommended", + "plugin:react/recommended" + ], + "parserOptions": { + "ecmaFeatures": { + "jsx": true + }, + "ecmaVersion": "latest", + "sourceType": "module" + }, + "plugins": [ + "react" + ], + "settings": { + "react": { + "version": "detect" + } + }, + "ignorePatterns": ["dist"], + "rules": { + "indent": ["error", 2], + "quotes": ["error", "single"], + "semi": ["error", "always"], + "jsx-quotes": ["error", "prefer-single"] + } +} diff --git a/README.md b/README.md index 8dbf4e5..0839d93 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # SplashScreen + Dynamo Splash Screen [![License](https://img.shields.io/npm/l/@dynamods/splash-screen)](https://github.com/DynamoDS/SplashScreen/blob/master/LICENSE) @@ -66,6 +67,19 @@ If you need to update `npm`, you can make it using `npm`! npm run bundle +## Lint + +We use [ESlint](https://eslint.org/) to analyze and find problems. It has [integrations](https://eslint.org/docs/latest/user-guide/integrations) for various editors and other tools. + +- To find problems + + npm run lint:check + +- To fix problems + + npm run lint:fix + ## Generate Third Party License Info -* to generate about box html files use `npm run generate_license`, this will output alternative about box files to `license_output/` One will contain the full transitive production dep list, the other will contain the direct production deps. -* These files will be packed into the released npm package \ No newline at end of file + +- to generate about box html files use `npm run generate_license`, this will output alternative about box files to `license_output/` One will contain the full transitive production dep list, the other will contain the direct production deps. +- These files will be packed into the released npm package diff --git a/package-lock.json b/package-lock.json index eda85c7..e04a164 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "splash-screen", - "version": "0.1.0", + "version": "0.2.2", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "splash-screen", - "version": "0.1.0", + "version": "0.2.2", "dependencies": { "bootstrap": "^5.2.1", "react": "^18.2.0", diff --git a/package.json b/package.json index 56bb9ae..be3f8e6 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@dynamods/splash-screen", - "version": "0.2.1", + "version": "0.2.2", "description": "Splash Screen maintained by Dynamo Team@Autodesk", "author": "Autodesk Inc.", "license": "MIT", @@ -21,6 +21,8 @@ "react-scripts": "5.0.1" }, "scripts": { + "lint:check": "eslint src/", + "lint:fix": "eslint src/ --fix", "start": "webpack serve --config webpack.config.js", "build": "webpack --config webpack.config.js --mode=development", "bundle": "webpack --config webpack.config.js --mode=production", diff --git a/public/index.html b/public/index.html index f15979d..c3cb8de 100644 --- a/public/index.html +++ b/public/index.html @@ -1,16 +1,15 @@ +
- - - \ No newline at end of file +