Autogenerated new docs and demo at Fri Aug 28 2015 13:11:33

Author: nzakas

_posts/2015-08-28-eslint-v1.3.0-released.md

@@ -0,0 +1,88 @@
+---
+layout: post
+title: ESLint v1.3.0 released
+tags:
+  - release
+  - minor
+---
+# ESLint v1.3.0 released
+
+We just pushed ESLint v1.3.0, which is a minor release upgrade of ESLint. This release adds some new features and fixes several bugs found in the previous release.
+
+
+
+
+
+
+## Features
+
+
+* New: `no-useless-concat` rule (fixes [#3506](https://github.com/eslint/eslint/issues/3506)) (Henry Zhu)
+* New: Added HTML formatter (fixes [#3505](https://github.com/eslint/eslint/issues/3505)) (Julian Laval)
+* New: Protractor environment (fixes [#3457](https://github.com/eslint/eslint/issues/3457)) (James Whitney)
+
+
+
+
+## Enhancements
+
+
+* Update: Add `keywords` flag to `consistent-as-needed` mode in `quote-props` (fixes [#3532](https://github.com/eslint/eslint/issues/3532)) (Burak Yigit Kaya)
+* Update: adds `numbers` option  to quote-props (fixes [#2914](https://github.com/eslint/eslint/issues/2914)) (Jose Roberto Vidal)
+* Update: Return to accept `undefined` type (fixes [#3382](https://github.com/eslint/eslint/issues/3382)) (Gyandeep Singh)
+* Update: Quote var name in `no-unused-vars` error messages (refs [#3526](https://github.com/eslint/eslint/issues/3526)) (Burak Yigit Kaya)
+* Update: Move methods to SourceCode (fixes [#3516](https://github.com/eslint/eslint/issues/3516)) (Nicholas C. Zakas)
+* Update: Add quotes around the label in  `no-empty-label` error reports (fixes [#3526](https://github.com/eslint/eslint/issues/3526)) (Burak Yigit Kaya)
+* Update: `newline-after-var` Allow comment + blank after var (fixes [#2852](https://github.com/eslint/eslint/issues/2852)) (Ian VanSchooten)
+* Update: Add `unnecessary` option to `quote-props` (fixes [#3381](https://github.com/eslint/eslint/issues/3381)) (Burak Yigit Kaya)
+* Update: separate options for block and line comments in `spaced-comment` rule (fixes [#2897](https://github.com/eslint/eslint/issues/2897)) (Burak Yigit Kaya)
+* Update: Added "properties" option to `id-length` rule to ignore property names. (fixes [#3450](https://github.com/eslint/eslint/issues/3450)) (Mathieu M-Gosselin)
+* Update: add new ignore pattern options to no-unused-vars (fixes [#2321](https://github.com/eslint/eslint/issues/2321)) (Mathias Schreck)
+* Update: Allow pre-parsed code (fixes [#1025](https://github.com/eslint/eslint/issues/1025), fixes [#948](https://github.com/eslint/eslint/issues/948)) (Nicholas C. Zakas)
+
+
+
+
+## Bug Fixes
+
+
+* Fix: `quote-props` rule should ignore computed and shorthand properties (fixes [#3557](https://github.com/eslint/eslint/issues/3557)) (fixes [#3544](https://github.com/eslint/eslint/issues/3544)) (Burak Yigit Kaya)
+* Fix: check space after yield keyword in space-unary-ops (fixes [#2707](https://github.com/eslint/eslint/issues/2707)) (Mathias Schreck)
+* Fix: Don't try too hard to find fault in `no-implicit-coercion` (refs [#3402](https://github.com/eslint/eslint/issues/3402)) (Burak Yigit Kaya)
+* Fix: Detect ternary operator in operator-linebreak rule (fixes [#3274](https://github.com/eslint/eslint/issues/3274)) (Burak Yigit Kaya)
+* Fix: ASI indentation issue (fixes [#3514](https://github.com/eslint/eslint/issues/3514)) (Burak Yigit Kaya)
+* Fix: Make `no-implicit-coercion` smarter about numerical expressions (fixes [#3510](https://github.com/eslint/eslint/issues/3510)) (Burak Yigit Kaya)
+* Fix: `prefer-template` had not been handling TemplateLiteral as literal node (fixes [#3507](https://github.com/eslint/eslint/issues/3507)) (Toru Nagashima)
+* Fix: `indent` shouldn't check the last line unless it is a punctuator (fixes [#3498](https://github.com/eslint/eslint/issues/3498)) (Burak Yigit Kaya)
+* Fix: `indent` rule does not indent when doing multi-line chain calls (fixes [#3279](https://github.com/eslint/eslint/issues/3279)) (Burak Yigit Kaya)
+* Fix: sort-vars rule fails when memo is undefined (fixes [#3474](https://github.com/eslint/eslint/issues/3474)) (Burak Yigit Kaya)
+* Fix: `brace-style` doesn't report some closing brace errors (fixes [#3486](https://github.com/eslint/eslint/issues/3486)) (Burak Yigit Kaya)
+* Fix: `indent` does not check FunctionDeclaration nodes properly (fixes [#3173](https://github.com/eslint/eslint/issues/3173)) (Burak Yigit Kaya)
+
+
+
+
+## Documentation
+
+
+* Docs: Add config comments for rule examples 'accessor-pairs' to 'no-extra-semi' (refs [#2271](https://github.com/eslint/eslint/issues/2271)) (Ian VanSchooten)
+* Docs: (curly) Fix broken code in example (Kent C. Dodds)
+* Docs: Clearer plugin rule configuration (fixes [#2022](https://github.com/eslint/eslint/issues/2022)) (Nicholas C. Zakas)
+* Docs: Turn off Liquid in example (Nicholas C. Zakas)
+* Docs: Mention CommonJS along with Node.js (fixes [#3388](https://github.com/eslint/eslint/issues/3388)) (Nicholas C. Zakas)
+* Docs: Make it clear which rules are recommended (fixes [#3398](https://github.com/eslint/eslint/issues/3398)) (Nicholas C. Zakas)
+* Docs: Add links to JSON Schema resources (fixes [#3411](https://github.com/eslint/eslint/issues/3411)) (Nicholas C. Zakas)
+* Docs: Add more info to migration guide (fixes [#3439](https://github.com/eslint/eslint/issues/3439)) (Nicholas C. Zakas)
+* Docs: Added section to shareable config (Gregory Waxman)
+
+
+
+
+
+
+## Build Related
+
+
+* Build: Autogenerate release blog post (fixes [#3562](https://github.com/eslint/eslint/issues/3562)) (Nicholas C. Zakas)
+
+

docs/developer-guide/nodejs-api.md

@@ -9,6 +9,18 @@ While ESLint is designed to be run on the command line, it's possible to use ESL
 
 **Note:** Use undocumented parts of the API at your own risk. Only those parts that are specifically mentioned in this document are approved for use and will remain stable and reliable. Anything left undocumented is unstable and may change or be removed at any point.
 
+## SourceCode
+
+The `SourceCode` type represents the parsed source code that ESLint executes on. It's used internally in ESLint and is also available so that already-parsed code can be used. You can create a new instance of `SourceCode` by passing in the text string representing the code and an abstract syntax tree (AST) in [ESTree](https://github.com/estree/estree) format (including location information, range information, comments, and tokens):
+
+```js
+var SourceCode = require("eslint").SourceCode;
+
+var code = new SourceCode("var foo = bar;", ast);
+```
+
+The `SourceCode` constructor throws an error if the AST is missing any of the required information.
+
 ## linter
 
 The `linter` object does the actual evaluation of the JavaScript code. It doesn't do any filesystem operations, it simply parses and reports on the code. You can retrieve `linter` like this:
@@ -19,7 +31,7 @@ var linter = require("eslint").linter;
 
 The most important method on `linter` is `verify()`, which initiates linting of the given text. This method accepts four arguments:
 
-* `code` - the source code to lint (a string).
+* `code` - the source code to lint (a string or instance of `SourceCode`).
 * `config` - a configuration object.
 * `filename` - (optional) the filename to associate with the source code.
 * `saveState` - (optional) set to true to maintain the internal state of `linter` after linting (mostly used for testing purposes).
@@ -34,6 +46,19 @@ var messages = linter.verify("var foo;", {
         semi: 2
     }
 }, "foo.js");
+
+// or using SourceCode
+
+var linter = require("eslint").linter,
+    SourceCode = require("eslint").SourceCode;
+
+var code = new SourceCode("var foo = bar;", ast);
+
+var messages = linter.verify(code, {
+    rules: {
+        semi: 2
+    }
+}, "foo.js");
 ```
 
 The `verify()` method returns an array of objects containing information about the linting warnings and errors. Here's an example:
@@ -61,6 +86,24 @@ The information available for each linting message is:
 * `severity` - either 1 or 2, depending on your configuration.
 * `source` - the line of code where the problem is (or empty string if it can't be found).
 
+You can also get an instance of the `SourceCode` object used inside of `linter` by using the `getSourceCode()` method:
+
+```js
+var linter = require("eslint").linter;
+
+var messages = linter.verify("var foo = bar;", {
+    rules: {
+        semi: 2
+    }
+}, "foo.js");
+
+var code = linter.getSourceCode();
+
+console.log(code.text);     // "var foo = bar;"
+```
+
+In this way, you can retrieve the text and AST used for the last run of `linter.verify()`.
+
 ## CLIEngine
 
 The primary Node.js API is `CLIEngine`, which is the underlying utility that runs the ESLint command line interface. This object will read the filesystem for configuration and file information but will not output any results. Instead, it allows you direct access to the important information so you can deal with the output yourself.

docs/developer-guide/shareable-configs.md

@@ -91,6 +91,73 @@ Note that you can leave off the `.js` from the filename. In this way, you can ad
 
 **Important:** We strongly recommend always including a default config for your plugin to avoid errors.
 
+## Local Config File Resolution
+
+If you need to make multiple configs that can extend from each other and live in different directories, you can create a single shareable config that handles this scenario.
+
+As an example, let's assume you're using the package name `eslint-config-myconfig` and your package looks something like this:
+
+```text
+myconfig
+├── index.js
+└─┬ lib
+  ├── defaults.js
+  ├── dev.js
+  ├── ci.js
+  └─┬ ci
+    ├── frontend.js
+    ├── backend.js
+    └── common.js
+```
+
+In your `index.js` you can do something like this:
+
+```js
+module.exports = require('./lib/ci.js);
+```
+
+Now inside your package you have `/lib/defaults.js`, which contains:
+
+```js
+module.exports = {
+    rules: {
+        'no-console': 1
+    }
+};
+```
+
+Inside your `/lib/ci.js` you have
+
+```js
+module.exports = require('./ci/backend');
+```
+
+Inside your `/lib/ci/common.js`
+
+```js
+module.exports = {
+    rules: {
+        'no-alert': 2
+    },
+    extends: 'myconfig/lib/defaults'
+};
+```
+
+Despite being in an entirely different directory, you'll see that all `extends` must use the full package path to the config file you wish to extend.
+
+Now inside your `/lib/ci/backend.js`
+
+```js
+module.exports = {
+    rules: {
+        'no-console': 1
+    },
+    extends: 'myconfig/lib/ci/common'
+};
+```
+
+In the last file, you'll once again see that to properly resolve your config, you'll need include the full package path.
+
 ## Further Reading
 
 * [npm Developer Guide](https://www.npmjs.org/doc/misc/npm-developers.html)