eslint-plugin-strudel - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

lib/index.js

@@ -0,5 +1,16 @@
+'use strict';
+
 module.exports = {
-    rules: {
-      'redundant-init': require('./rules/redundant-init'),
-    }
-}
+  rules: {
+    "no-useless-init": require("./rules/no-useless-init"),
+    "first-method-init": require("./rules/first-method-init"),
+    "element-on-top": require("./rules/element-on-top"),
+    "oninit-on-top": require("./rules/oninit-on-top"),
+    "element-import": require("./rules/element-import"),
+    "single-line-el": require("./rules/single-line-el")
+  },
+  configs: {
+    'base': require('./configs/base'),
+    'recommended': require('./configs/recommended'),
+  }
+};

package.json

 {
   "name": "eslint-plugin-strudel",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "ESLint plugin for Strudel.js",
@@ -8,3 +8,3 @@ "main": "lib/index.js",
     "start": "npm run test -- --watch",
-    "test": "mocha \"test/lib/**/*.js\" --reporter dot"
+    "test": "mocha test/lib/*.js"
   },
@@ -23,3 +23,6 @@ "files": [
   ],
-  "author": "Mateusz Luczak <[e-mail]>",
+  "authors": "Mateusz Luczak <[e-mail]>",
+  "contributors": [
+    "Mikołaj Kozakiewicz <[e-mail]>"
+  ],
   "license": "MIT",
@@ -30,6 +33,16 @@ "bugs": {
   "homepage": "https://github.com/strudeljs/eslint-plugin-strudel#readme",
+  "dependencies": {
+    "babel-eslint": "^8.2.5"
+  },
+  "engines": {
+    "node": ">=6.5"
+  },
+  "peerDependencies": {
+    "eslint": "^5.0.0"
+  },
   "devDependencies": {
-    "eslint": "^5.1.0",
+    "chai": "^4.1.2",
+    "eslint": "^5.3.0",
     "mocha": "^5.2.0"
   }
 }

README.md

 # eslint-plugin-strudel
 
+<p>
+<a href="https://www.npmjs.com/package/eslint-plugin-strudel"><img src="https://img.shields.io/npm/v/eslint-plugin-strudel.svg" alt="Version"></a>
+<a href="https://www.npmjs.com/package/eslint-plugin-strudel"><img src="https://img.shields.io/npm/l/eslint-plugin-strudel.svg" alt="License"></a> 
+</p>
+
+> Official ESLint plugin for Strudel.js
+
+## Requirements
+
+* ESLint `^5.0.0`
+* Node.js `>=6.10.0`
+
 ## Installation
@@ -8,10 +20,39 @@
 ```
-$ npm i eslint -D
-$ npm install eslint-plugin-strudel -D
+$ npm i eslint eslint-plugin-strudel -D
 ```
 
-# List of supported rules
+## Usage
 
-* [strudel/redundant-init](docs/rules/redundant-init.md): enforce `OnInit` when redundant init method
+Create `.eslintrc` file to configure rules. See: [http://eslint.org/docs/user-guide/configuring](ttp://eslint.org/docs/user-guide/configuring)
 
+Example `.eslintrc.js`:
+```
+{
+  "extends": [
+    "plugin:strudel/recommended"
+  ]
+}
+```
+
+## Configs
+
+This plugin provides two predefined configs:
+
+* `plugin:strudel/base`: Settings and rules to enable correct ESLint parsing
+* `plugin:strudel/recommended`: Above, plus rules to prevent errors and ensure consistency
+
+## Rules
+
+* [strudel/element-import](docs/rules/element-import.md): enforce importing `element` as `$`
+* [strudel/single-line-el](docs/rules/single-line-el.md): enforce using @El with it's property in one line
+* [strudel/no-useless-init](docs/rules/no-useless-init.md): prevent useless init method
+* [strudel/first-method-init](docs/rules/first-method-init.md): enforce init being first method if used
+* [strudel/oninit-on-top](docs/rules/oninit-on-top.md): enforces methods decorated with @OnInit to be first methods of class
+* [strudel/element-on-top](docs/rules/element-on-top.md): enforces properties decorated with @El to be on top of class body
+
+## Contribution
+Before you start writing new rule, please read the official [ESLint guide](https://eslint.org/docs/developer-guide/working-with-rules).
+Next you need to get an idea how the AST looks like - use [astexplorer.net](http://astexplorer.net/) to inspect ASTs.
+When writing tests for rules [Debugging Mocha guide for Visual Studio Code](https://github.com/Microsoft/vscode-recipes/tree/master/debugging-mocha-tests) may become helpful.
+
 ## License
@@ -18,0 +59,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11696

increased by361.02%

Number of package files

12

increased by140%

Lines of code

228

increased by1420%

Number of lines in readme file

62

increased by195.24%

Worsened metrics

Dependency count

2

increased byInfinity%

Dev dependency count

3

increased by50%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedbabel-eslint@^8.2.5

• + Added@babel/code-frame@7.0.0-beta.447.24.7(transitive)

• + Added@babel/generator@7.0.0-beta.44(transitive)

• + Added@babel/helper-function-name@7.0.0-beta.44(transitive)

• + Added@babel/helper-get-function-arity@7.0.0-beta.44(transitive)

• + Added@babel/helper-split-export-declaration@7.0.0-beta.44(transitive)

• + Added@babel/helper-validator-identifier@7.24.7(transitive)

• + Added@babel/highlight@7.0.0-beta.447.24.7(transitive)

• + Added@babel/template@7.0.0-beta.44(transitive)

• + Added@babel/traverse@7.0.0-beta.44(transitive)

• + Added@babel/types@7.0.0-beta.44(transitive)

• + Addedacorn@6.4.2(transitive)

• + Addedacorn-jsx@5.3.2(transitive)

• + Addedajv@6.12.6(transitive)

• + Addedansi-escapes@3.2.0(transitive)

• + Addedansi-regex@3.0.14.1.1(transitive)

• + Addedansi-styles@3.2.1(transitive)

• + Addedargparse@1.0.10(transitive)

• + Addedastral-regex@1.0.0(transitive)

• + Addedbabel-eslint@8.2.6(transitive)

• + Addedbabylon@7.0.0-beta.44(transitive)

• + Addedbalanced-match@1.0.2(transitive)

• + Addedbrace-expansion@1.1.11(transitive)

• + Addedcallsites@3.1.0(transitive)

• + Addedchalk@2.4.2(transitive)

• + Addedchardet@0.7.0(transitive)

• + Addedcli-cursor@2.1.0(transitive)

• + Addedcli-width@2.2.1(transitive)

• + Addedcolor-convert@1.9.3(transitive)

• + Addedcolor-name@1.1.3(transitive)

• + Addedconcat-map@0.0.1(transitive)

• + Addedcross-spawn@6.0.5(transitive)

• + Addeddebug@3.2.74.3.5(transitive)

• + Addeddeep-is@0.1.4(transitive)

• + Addeddoctrine@3.0.0(transitive)

• + Addedemoji-regex@7.0.3(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedeslint@5.16.0(transitive)

• + Addedeslint-scope@3.7.14.0.3(transitive)

• + Addedeslint-utils@1.4.3(transitive)

• + Addedeslint-visitor-keys@1.3.0(transitive)

• + Addedespree@5.0.1(transitive)

• + Addedesprima@4.0.1(transitive)

• + Addedesquery@1.5.0(transitive)

• + Addedesrecurse@4.3.0(transitive)

• + Addedestraverse@4.3.05.3.0(transitive)

• + Addedesutils@2.0.3(transitive)

• + Addedexternal-editor@3.1.0(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedfast-levenshtein@2.0.6(transitive)

• + Addedfigures@2.0.0(transitive)

• + Addedfile-entry-cache@5.0.1(transitive)

• + Addedflat-cache@2.0.1(transitive)

• + Addedflatted@2.0.2(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedfunctional-red-black-tree@1.0.1(transitive)

• + Addedglob@7.2.3(transitive)

• + Addedglobals@11.12.0(transitive)

• + Addedhas-flag@3.0.0(transitive)

• + Addediconv-lite@0.4.24(transitive)

• + Addedignore@4.0.6(transitive)

• + Addedimport-fresh@3.3.0(transitive)

• + Addedimurmurhash@0.1.4(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedinquirer@6.5.2(transitive)

• + Addedinvariant@2.2.4(transitive)

• + Addedis-fullwidth-code-point@2.0.0(transitive)

• + Addedisexe@2.0.0(transitive)

• + Addedjs-tokens@3.0.24.0.0(transitive)

• + Addedjs-yaml@3.14.1(transitive)

• + Addedjsesc@2.5.2(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stable-stringify-without-jsonify@1.0.1(transitive)

• + Addedlevn@0.3.0(transitive)

• + Addedlodash@4.17.21(transitive)

• + Addedloose-envify@1.4.0(transitive)

• + Addedmimic-fn@1.2.0(transitive)

• + Addedminimatch@3.1.2(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addedms@2.1.22.1.3(transitive)

• + Addedmute-stream@0.0.7(transitive)

• + Addednatural-compare@1.4.0(transitive)

• + Addednice-try@1.0.5(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedonetime@2.0.1(transitive)

• + Addedoptionator@0.8.3(transitive)

• + Addedos-tmpdir@1.0.2(transitive)

• + Addedparent-module@1.0.1(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedpath-is-inside@1.0.2(transitive)

• + Addedpath-key@2.0.1(transitive)

• + Addedpicocolors@1.0.1(transitive)

• + Addedprelude-ls@1.1.2(transitive)

• + Addedprogress@2.0.3(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedregexpp@2.0.1(transitive)

• + Addedresolve-from@4.0.0(transitive)

• + Addedrestore-cursor@2.0.0(transitive)

• + Addedrimraf@2.6.3(transitive)

• + Addedrun-async@2.4.1(transitive)

• + Addedrxjs@6.6.7(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsemver@5.7.2(transitive)

• + Addedshebang-command@1.2.0(transitive)

• + Addedshebang-regex@1.0.0(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedslice-ansi@2.1.0(transitive)

• + Addedsource-map@0.5.7(transitive)

• + Addedsprintf-js@1.0.3(transitive)

• + Addedstring-width@2.1.13.1.0(transitive)

• + Addedstrip-ansi@4.0.05.2.0(transitive)

• + Addedstrip-json-comments@2.0.1(transitive)

• + Addedsupports-color@5.5.0(transitive)

• + Addedtable@5.4.6(transitive)

• + Addedtext-table@0.2.0(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedtmp@0.0.33(transitive)

• + Addedto-fast-properties@2.0.0(transitive)

• + Addedtrim-right@1.0.1(transitive)

• + Addedtslib@1.14.1(transitive)

• + Addedtype-check@0.3.2(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addedwhich@1.3.1(transitive)

• + Addedword-wrap@1.2.5(transitive)

• + Addedwrappy@1.0.2(transitive)

• + Addedwrite@1.0.3(transitive)