@updater/eslint-plugin - npm Package Compare versions

Comparing version 0.0.8 to 0.0.9

package.json

 {
   "name": "@updater/eslint-plugin",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "ESLint rules for JavaScript at Updater",
   "keywords": ["eslint", "eslintplugin", "eslint-plugin"],
   "author": "David Michael",
-  "peerDependencies": {},
+  "peerDependencies": {
+    "eslint": "~3.16.1",
+    "prettier": "^1.8.2"
+  },
   "dependencies": {
     "eslint-plugin-prefer-object-spread": "^1.2.1",
-    "eslint-plugin-prettier": "^2.3.1",
-    "prettier": "^1.8.2",
-    "eslint": "~3.16.1"
+    "eslint-plugin-prettier": "^2.3.1"
   },
   "license": "ISC"
 }

README.md

@@ -1,5 +0,10 @@
-# eslint-plugin-services
+# JavaScript code style and code quality at Updater
 
-ESLint rules for JavaScript services at Updater
+This plugin is used to establish both code style and code quality practices for
+writing JavaScript at Updater. As a plugin, evolution and governance of code
+style is encouraged. These rules are not written in stone as they say.
 
+Through the use of configs, this plugin can service custom implementations
+across teams.
+
 ## Installation
@@ -10,28 +15,39 @@
 ```
-$ npm i eslint --save-dev
+$ yarn add --dev eslint
 ```
 
-Next, install `eslint-plugin-services`:
+Next, install this plugin:
 
 ```
-$ npm install eslint-plugin-services --save-dev
+$ yarn add --dev @updater/eslint-plugin
 ```
 
-**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-services` globally.
+The `services` configuration requires [Prettier](https://prettier.io/), which is
+specified in the `peerDependencies` of the `package.json` file. Since
+`peerDependencies` will only give a warning to the user, this should also be
+installed in the host code repo if you are using the `services` config.
 
 ## Usage
 
-Add `services` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+Extend the plugin in your `.eslintrc` configuration file
 
 ```json
 {
-    "plugins": [
-        "services"
-    ]
+  "extends": "plugin:@updater/eslint-plugin/services"
 }
 ```
 
+## Governance
 
+The rules here are meant to change. Please issue a PR for any rule changes and
+they will considered, debated, and ratified among the teams it might affect. We
+aim to make this a painless and iterative process.
 
+## Publishing
 
+This lib is currently not integrated into CI. To publish, increment the version
+in `package.json` and run the following
 
+```
+$ npm publish
+```

No alert changes

Improved metrics

Total package byte prevSize

104282

increased by0.75%

Number of lines in readme file

53

increased by43.24%

Dependency changes

• + Addedcall-bind-apply-helpers@1.0.1(transitive)

• - Removedeslint@~3.16.1

• - Removedprettier@^1.8.2

• - Removedcall-bind-apply-helpers@1.0.2(transitive)