@coko/lint 1.4.0 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.0.0](https://gitlab.coko.foundation/cokoapps/lint/compare/v1.4.0...v2.0.0) (2022-03-21)
+
+
+### ⚠ BREAKING CHANGES
+
+* husky needs a migration to hook files
+
+* upgrade dependencies ([7be266a](https://gitlab.coko.foundation/cokoapps/lint/commit/7be266af0d829af54b2d909040643c8439802d2e))
+
 ## [1.4.0](https://gitlab.coko.foundation///compare/v1.3.0...v1.4.0) (2021-01-09)
 
 

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Aspiration
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,145 +1 @@
-This package provides everything that is needed to lint applications built by the Coko team.
-
-Features / libraries provided, along with their configuration:
-
-- **Eslint**
-- **Stylelint**
-- **Prettier**
-- **Husky** (to provide pre-commit hooks)
-- **Lint-staged** (combined with husky, will run linters on staged code before it is commited)
-- **Commitlint** (to lint the commit message itself)
-- **Commitizen** (to provide the cli helper for the conventional commit standard)
-
-To install:
-
-```
-yarn add --dev @coko/lint
-```
-
-You shouldn't need to install any other dependency.  
-Just follow the instructions below.
-
-All files below should be added to the root folder of your project, unless otherwise specified, or if you have a specific reason not to.
-
-# Eslint
-
-Add an `.eslintrc.js` in your root folder:
-
-```js
-const { eslint } = require('@coko/lint')
-
-/**
- * You can edit the eslint config file here.
- *
- * eg.
- * eslint.rules['no-console'] = ['warn', { allow: ['error', 'warn'] }],
- *
- */
-
-module.exports = eslint
-```
-
-# Prettier
-
-Add a `.prettierrc.js` file:
-
-```js
-const { prettier } = require('@coko/lint')
-
-/**
- * You can edit the config here:
- *
- * eg.
- * prettier.semi = true
- *
- */
-
-module.exports = prettier
-```
-
-# Stylelint
-
-Add a `.stylelintrc.js` file:
-
-```js
-const { stylelint } = require('@coko/lint')
-
-/**
- * You can edit the config here:
- *
- * eg.
- * stylelint.rules['your-rule'] = true
- *
- */
-
-module.exports = stylelint
-```
-
-# Commitlint, Lint staged & Commitizen
-
-`commitlint` lints your commits to make sure it follows the conventional commits specification. `lint-staged` will run the linters on changes staged in git. These two will be executed every time a commit is made, with the help of `husky`'s `pre-commit` hook.
-
-The following also adds `commitizen`, an interactive cli tool to build valid commits (run it with `yarn cz`).
-
-Create a `.commitlintrc.js` file:
-
-```js
-module.exports = {
-  extends: ['@commitlint/config-conventional'],
-}
-```
-
-Add a `.lintstagedrc.js` file:
-
-```js
-const { lintstaged } = require('@coko/lint')
-
-/**
- * You can edit the config here:
- *
- * eg.
- * lintstaged.linters['*.js'] = ['my-custom-linter']
- *
- */
-
-module.exports = lintstaged
-```
-
-Create a `.cz-config.js` file:
-
-```js
-const { commitizen } = require('@coko/lint')
-
-/**
- * You can edit the config before you export it to suit your needs.
- *
- * eg.
- * commitizen.scopes = [
- *    'dashboard',
- *    'team manager',
- *    'api',
- *    'models',
- *    '*'
- * ]
- */
-
-module.exports = commitizen
-```
-
-Finally, add the following lines to your `package.json`:
-
-```json
-"scripts": {
-  "cz": "git-cz"
-},
-"config": {
-  "commitizen": {
-    "path": "cz-customizable"
-  }
-},
-"husky": {
-  "hooks": {
-    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS && lint-staged"
-  }
-}
-```
+Documentation can be found [here](https://dev.coko.foundation/?path=/docs/common-libraries-lint--page).

package/package.json

@@ -1,72 +1,72 @@
 {
   "name": "@coko/lint",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "Linter configurations and dependencies for coko's projects",
-  "main": "src/index.js",
-  "scripts": {
-    "cz": "git-cz",
-    "release": "standard-version",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git@gitlab.coko.foundation:cokoapps/lint.git"
-  },
   "keywords": [
     "lint",
     "pubsweet",
     "coko"
   ],
-  "author": "Yannis Barlas",
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.coko.foundation:cokoapps/lint.git"
+  },
   "license": "MIT",
-  "publishConfig": {
-    "access": "public"
+  "author": "Yannis Barlas",
+  "main": "src/index.js",
+  "files": [
+    "src"
+  ],
+  "scripts": {
+    "cz": "git-cz",
+    "prepare": "husky install",
+    "release": "standard-version",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-customizable"
+    }
   },
   "dependencies": {
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
-    "babel-eslint": "^10.1.0",
-    "commitizen": "^4.0.3",
+    "@babel/core": "^7.17.7",
+    "@babel/eslint-parser": "^7.17.0",
+    "@babel/preset-react": "^7.16.7",
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
+    "commitizen": "^4.2.4",
     "conventional-commit-types": "^3.0.0",
-    "cz-conventional-changelog": "^3.1.0",
-    "cz-customizable": "^6.2.0",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb": "^18.1.0",
-    "eslint-config-prettier": "^6.10.1",
-    "eslint-config-standard": "^14.1.1",
-    "eslint-config-standard-react": "^9.2.0",
-    "eslint-plugin-cypress": "^2.11.2",
-    "eslint-plugin-import": "^2.20.1",
-    "eslint-plugin-jest": "^23.8.2",
-    "eslint-plugin-jsx-a11y": "^6.2.3",
-    "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-prettier": "^3.1.2",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-react": "^7.19.0",
-    "eslint-plugin-react-hooks": "^2.5.1",
-    "eslint-plugin-standard": "^4.0.1",
-    "husky": "^4.2.3",
-    "lint-staged": "^10.4.2",
+    "cz-conventional-changelog": "^3.3.0",
+    "cz-customizable": "^6.3.0",
+    "eslint": "^8.11.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-config-standard-react": "^11.0.1",
+    "eslint-plugin-cypress": "^2.12.1",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.1.1",
+    "eslint-plugin-jsx-a11y": "^6.5.1",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-react": "^7.29.4",
+    "eslint-plugin-react-hooks": "^4.3.0",
+    "husky": "^7.0.4",
+    "lint-staged": "^12.3.7",
     "longest": "^2.0.1",
-    "prettier": "^2.0.2",
+    "postcss-scss": "^4.0.3",
+    "prettier": "^2.6.0",
     "right-pad": "^1.0.1",
-    "stylelint": "^13.7.2",
-    "stylelint-config-recommended": "^3.0.0",
+    "stylelint": "^14.6.0",
+    "stylelint-config-standard-scss": "^3.0.0",
     "stylelint-config-styled-components": "^0.1.1",
-    "stylelint-order": "^4.1.0",
+    "stylelint-order": "^5.0.0",
     "stylelint-processor-styled-components": "^1.10.0"
   },
   "devDependencies": {
-    "standard-version": "^7.1.0"
+    "standard-version": "^9.3.2"
   },
-  "config": {
-    "commitizen": {
-      "path": "cz-customizable"
-    }
-  },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
+  "publishConfig": {
+    "access": "public"
   }
 }

package/src/eslint.js

@@ -1,5 +1,11 @@
 module.exports = {
-  parser: 'babel-eslint',
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    requireConfigFile: false,
+    babelOptions: {
+      presets: ['@babel/preset-react'],
+    },
+  },
   env: {
     browser: true,
     es6: true,
@@ -13,10 +19,8 @@ module.exports = {
     'plugin:jest/recommended',
     'plugin:cypress/recommended',
     'prettier',
-    'prettier/react',
-    'prettier/standard',
   ],
-  plugins: ['jest', 'prettier'],
+  plugins: ['jest'],
   ignorePatterns: [
     '_build',
     'dist',
@@ -28,8 +32,10 @@ module.exports = {
     '!.lintstagedrc.js',
     '!.prettierrc.js',
     '!.stylelintrc.js',
+    '**/node_modules',
   ],
   rules: {
+    'arrow-body-style': 0,
     'import/no-extraneous-dependencies': [
       'error',
       {
@@ -37,12 +43,15 @@ module.exports = {
           // storybook
           '.storybook/*',
           '**/stories/**/*.js',
+
           // tests
           'cypress/**',
           '**/*.spec.js',
           '**/*.test.js',
+
           // webpack
           'webpack/**',
+
           // configs
           '.commitlintrc.js',
           '.cz-config.js',
@@ -51,6 +60,7 @@ module.exports = {
           '.lintstagedrc.js',
           '.prettierrc.js',
           '.stylelintrc.js',
+
           // other
           'dev/**',
         ],
@@ -74,8 +84,13 @@ module.exports = {
       { blankLine: 'always', prev: '*', next: 'multiline-const' },
       { blankLine: 'always', prev: 'multiline-const', next: '*' },
     ],
-    'prettier/prettier': 'error',
+    // 'prettier/prettier': 'error',
+    'react/function-component-definition': [
+      2,
+      { namedComponents: 'arrow-function' },
+    ],
     'react/jsx-filename-extension': [2, { extensions: ['.js'] }], // disallows .jsx files
+    'react/jsx-props-no-spreading': 0,
     'react/jsx-sort-props': [1, { ignoreCase: true }],
     'react/prop-types': [
       2,

package/src/lintstaged.js

@@ -1,4 +1,4 @@
 module.exports = {
-  '*.js': ['eslint --fix', 'stylelint'],
-  '*.{js,graphql,json,yml,md,html}': ['prettier --write'],
+  '*.js': ['eslint', 'stylelint'],
+  '*.{js,graphql,json,yml,md,html}': ['prettier --check'],
 }

package/src/stylelint.js

@@ -1,8 +1,9 @@
 module.exports = {
   extends: [
-    'stylelint-config-recommended',
+    'stylelint-config-standard-scss',
     'stylelint-config-styled-components',
   ],
+  customSyntax: 'postcss-scss',
   ignoreFiles: ['_build'],
   plugins: ['stylelint-order'],
   processors: ['stylelint-processor-styled-components'],
@@ -15,5 +16,12 @@ module.exports = {
       'always',
       { ignore: ['first-nested', 'after-comment'] },
     ],
+
+    'value-keyword-case': null,
+    'comment-empty-line-before': null,
+    'declaration-colon-newline-after': null,
+    'keyframes-name-pattern': null,
+    'declaration-empty-line-before': null,
+    'selector-class-pattern': null,
   },
 }

package/.cz-config.js

@@ -1,12 +0,0 @@
-const commitizenConfig = require('./src/commitizen')
-
-commitizenConfig.scopes = [
-  'eslint',
-  'prettier',
-  'stylelint',
-  'commitlint',
-  'lintstaged',
-  '*',
-]
-
-module.exports = commitizenConfig

package/.eslintignore

@@ -1,2 +0,0 @@
-!.cz-config.js
-!.eslintrc.js

package/.eslintrc.js

@@ -1,7 +0,0 @@
-module.exports = {
-  extends: ['airbnb', 'standard', 'prettier', 'prettier/standard'],
-  plugins: ['prettier'],
-  rules: {
-    'prettier/prettier': 'error',
-  },
-}

package/.prettierrc.js

@@ -1,3 +0,0 @@
-const prettier = require('./src/prettier')
-
-module.exports = prettier

package/commitlint.config.js

@@ -1 +0,0 @@
-module.exports = { extends: ['@commitlint/config-conventional'] }