eslint-config-segment - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

index.js

@@ -49,9 +49,27 @@ 'use strict';
     'space-after-keywords': [2, 'always'],
-    'space-before-blocks': [2, 'always'],
     'space-before-function-paren': [2, 'never'],
-    'space-in-brackets': [2, 'never'],
+    // FIXME: ESLint doesn't support our function brace style (`function(){}`)
+    // combined with our brace style (spaces, always) because it is, admittedly,
+    // an inconsistent style. We can either change our style or write a custom
+    // rule
+    //'space-before-blocks': [],
+    // FIXME: https://github.com/eslint/eslint/issues/2225
+    // What we want is this:
+    //   [1, 2, 3]
+    //   { a: 1, b: 2 }
+    //'space-in-brackets': [0, 'never'],
     'space-in-parens': [2, 'never'],
     'spaced-line-comment': [2, 'always'],
     'strict': [2, 'global'],
-    'valid-jsdoc': [1, { 'prefer': { 'returns': 'return' }, 'requireReturn': false, 'requireReturnDescription': false }],
+    // FIXME: https://github.com/eslint/eslint/issues/2108
+    // In order to really get benefit from this rule we need to either fix the
+    // above issue or stop adding a newline between our functions and their
+    // corresponding JSDoc block
+    'valid-jsdoc': [1, {
+      'prefer': {
+        'returns': 'return'
+      },
+      'requireReturn': false,
+      'requireReturnDescription': false
+    }],
     'wrap-iife': [2, 'outside'],
@@ -58,0 +76,0 @@ 'wrap-regex': 2,

package.json

 {
   "name": "eslint-config-segment",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Segment's base ESLint configuration.",
@@ -10,6 +10,6 @@ "author": "Segment <[e-mail]>",
     "type": "git",
-    "url": "git+https://github.com/segmentio/eslint-base.git"
+    "url": "git+https://github.com/segmentio/eslint-config.git"
   },
   "bugs": {
-    "url": "https://github.com/segmentio/eslint-base/issues"
+    "url": "https://github.com/segmentio/eslint-config/issues"
   },
@@ -16,0 +16,0 @@ "keywords": [

Readme.md

@@ -10,3 +10,3 @@ # eslint-config-segment
 ```bash
-$ npm install --save-dev eslint segment-eslint-config@"*"
+$ npm install --save-dev eslint eslint-config-segment
 ```
@@ -34,6 +34,16 @@
 
-If your project is an integration worker, your `.eslintrc` might look something like this:
+Is your test suite throwing all sorts of Mocha-related errors? Throw this in your `test/.eslintrc` (it'll inherit all your root `.eslintrc` settings, so no need to duplicate them here):
 
 ```json
 {
+  "env": {
+    "mocha": true
+  }
+}
+```
+
+If your project is a Node project, your `.eslintrc` might look something like this:
+
+```json
+{
   "extends": "segment/node"
@@ -55,5 +65,9 @@ }
 
+For more complex/real examples, see the [examples][] folder.
+
+
 For more details about how shareable configs work, see the [ESLint documentation][shareable configs].
 
 
+[examples]: /examples/
 [shareable configs]: http://eslint.org/docs/developer-guide/shareable-configs

No alert changes

Improved metrics

Total package byte prevSize

4865

increased by25.32%

Number of package files

6

increased by20%

Lines of code

104

increased by20.93%

Number of lines in readme file

71

increased by24.56%

No dependency changes