Merge pull request #9 from fs-webdev/clifSuggestions

Clif suggestions

Author: joeycozza

.travis.yml

@@ -6,9 +6,8 @@ before_install:
   - echo "//code.lds.org/artifactory/api/npm/npm-fhd/:_authToken=${NPM_PUBLISH_TOKEN}" >> .npmrc
   - echo "@fs:registry=https://code.lds.org/artifactory/api/npm/npm-fhd/" >> .npmrc
 deploy:
-  provider: npm
+  provider: script
   skip_cleanup: true
-  email: "[email protected]"
-  api_key: "$NPM_PUBLISH_TOKEN"
+  script: npm run publish
   on:
     branch: master

README.md

@@ -8,3 +8,15 @@ We have an eslint configuration setup for react projects. We HIGHLY recommend yo
 
 1.  Run `npm install @fs/eslint-config-frontier-react --save-dev`
 2.  Add `"extends": ["@fs/eslint-config-frontier-react"]` to your eslint config.
+
+### Opt in for linting jsdoc rules
+
+We have a configuration for jsdoc rules that you can use if your team decides they want to be more consistent with jsdocs
+
+1. Add a new entry to the `extends` field of your eslint config.
+    ```
+    "extends": [
+      "@fs/eslint-config-frontier-react",
+      "@fs/eslint-config-frontier-react/jsdoc"
+    ],
+    ```

es6.js

@@ -24,17 +24,18 @@ module.exports = {
     'arrow-parens': [1, 'as-needed'],
     'no-console': 'off',
     'no-param-reassign': 'off',
-    'no-use-before-define': ['error', { functions: false, classes: true, variables: true }],
+    'no-plusplus': 'off',
     'no-unused-expressions': ['warn', { allowShortCircuit: true }],
+    'no-use-before-define': ['error', { functions: false, classes: true, variables: true }],
+    'no-warning-comments': 1,
     'prefer-destructuring': 'off',
-    'no-plusplus': 'off',
 
     'jest/no-large-snapshots': 'error',
 
     'import/no-extraneous-dependencies': ['error', {devDependencies: ['**/*.stories.js', '**/*.test.js', '**/demo/**']}],
+
     "jsx-a11y/label-has-for": 0, // this is deprecated in future versions so disable now
-    "jsx-a11y/label-has-associated-control": [ 2, {
-      "assert": "either", // fs-styles does not support nesting currently
+    "jsx-a11y/label-has-associated-control": [ 2, { "assert": "either", // fs-styles does not support nesting currently
     }],
   },
 }

index.js

@@ -1,5 +1,5 @@
 module.exports = {
-  plugins: ['html'],
+  plugins: ['html', 'json'],
   extends: [
     '@fs/eslint-config-frontier-react/es6',
     '@fs/eslint-config-frontier-react/react',

jsdoc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  plugins: ['jsdoc'],
+  rules: {
+    'jsdoc/check-param-names': 2,
+    'jsdoc/check-tag-names': 2,
+    'jsdoc/check-types': 2,
+    'jsdoc/newline-after-description': 0,
+    'jsdoc/require-description-complete-sentence': 2,
+    'jsdoc/require-hyphen-before-param-description': 2,
+    'jsdoc/require-param': 2,
+    'jsdoc/require-param-description': 2,
+    'jsdoc/require-param-type': 2,
+    'jsdoc/require-returns-description': 2,
+    'jsdoc/require-returns-type': 2,
+  },
+}

package-lock.json

@@ -1,10 +1,11 @@
 {
   "name": "@fs/eslint-config-frontier-react",
-  "version": "1.4.0",
+  "version": "2.0.0-alpha.0",
   "description": "A common ESLint configuration setup for frontier apps",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Warning: no test specified\" && exit 0"
+    "test": "echo \"Warning: no test specified\" && exit 0",
+    "publish": "npmPublish"
   },
   "repository": {
     "type": "git",
@@ -31,6 +32,8 @@
     "eslint-plugin-html": "^5.0.3",
     "eslint-plugin-import": "^2.16.0",
     "eslint-plugin-jest": "22.5.1",
+    "eslint-plugin-jsdoc": "^8.0.1",
+    "eslint-plugin-json": "^1.4.0",
     "eslint-plugin-jsx-a11y": "^6.1.2",
     "eslint-plugin-no-autofix": "0.0.2",
     "eslint-plugin-only-warn": "^1.0.1",
@@ -40,6 +43,7 @@
     "prettier": "^1.15.3"
   },
   "devDependencies": {
+    "@fs/npm-publisher": "^1.0.0",
     "eslint": "^5.10.0"
   }
 }