eslint-config-arklint 1.2.2 → 1.3.1

package/.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.1.0.cjs

package/README.md

@@ -8,7 +8,12 @@ My personal ESLint configuration. Most of it is based on [eslint-config-react-ap
 ```shell
 yarn add eslint-config-arklint -D
 ```
-ESLint and all the plugins used in the config are dependencies, so no need to install them. I'm aware that ESLint is supposed to be in the `peerDependencies`, but since I'm maintaining my own packages, I'd rather have everything in one place for when I update the versions.
+
+You also need to add [ESLint](https://github.com/eslint/eslint) in your `devDependencies`:
+
+```shell
+yarn add eslint -D
+```
 
 ## Usage
 

package/extensions/jsdoc.js

@@ -33,19 +33,19 @@ module.exports = {
 				message: "The main description should be written in the third person, begin with a capital letter and end with a period.",
 				match: "/^[A-Z][.^\\w]*s\\b.*\\.$/us"
 			},
-			matchDescription: "[A-Z].*|^\\w+([-]*\\w)*( \\| \\w+([-]*\\w)*)*$",
+			matchDescription: "^[A-Z].*[^\\.]$",
 			tags: {
 				param: {
-					message: "@param description should begin with a capital letter or be a list of options separated by pipes.",
+					message: "@param description should begin with a capital letter and not end with a period.",
 					match: true
 				},
 				property: {
-					message: "@property description should begin with a capital letter or be a list of options separated by pipes.",
+					message: "@property description should begin with a capital letter and not end with a period.",
 					match: true
 				},
 				returns: {
-					message: "@returns description should begin with a capital letter.",
-					match: "[A-Z].*"
+					message: "@returns description should begin with a capital letter and not end with a period.",
+					match: true
 				}
 			}
 		}]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-arklint",
-  "version": "1.2.2",
+  "version": "1.3.1",
   "author": "Arkellys",
   "license": "MIT",
   "main": "index.js",
@@ -9,18 +9,27 @@
     "url": "git+https://github.com/Arkellys/eslint-config-arklint.git"
   },
   "homepage": "https://github.com/Arkellys/eslint-config-arklint#readme",
+  "scripts": {
+    "lint": "eslint ."
+  },
   "dependencies": {
     "@rushstack/eslint-patch": "^1.7.2",
     "confusing-browser-globals": "^1.0.11",
-    "eslint": "^8.56.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jsdoc": "^48.0.4",
+    "eslint-plugin-jsdoc": "^48.1.0",
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-sort-imports-es6-autofix": "^0.6.0"
   },
+  "devDependencies": {
+    "eslint": "^8.56.0"
+  },
+  "peerDependencies": {
+    "eslint": "^8.56.0"
+  },
   "eslintConfig": {
     "extends": "./index.js"
-  }
+  },
+  "packageManager": "yarn@4.1.0"
 }