diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..004409d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,13 @@ +root = true + +[*] +charset = utf8 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = tab +indent_size = 4 + +[{package.json,.travis.yml}] +indent_style = space +indent_size = 2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..59d842b --- /dev/null +++ b/.gitignore @@ -0,0 +1,28 @@ +# Logs +logs +*.log + +# Runtime data +pids +*.pid +*.seed + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directory +# Commenting this out is preferred by some people, see +# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- +node_modules + +# Users Environment Variables +.lock-wscript diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..3374031 --- /dev/null +++ b/.npmignore @@ -0,0 +1,7 @@ +node_modules +coverage +test +.editorconfig +.gitignore +.npmignore +.travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..43b2c77 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +sudo: false +language: node_js +node_js: +- '0.12' +deploy: + provider: npm + email: d2ltravisdeploy@d2l.com + api_key: + secure: TCRKHp6HU+iEuZgG7KzL5VSZHvBxSEBDM5QpyDWGvb26yO7jDgcen6pClskUXFHWV0IIIWE5sC0bbJsn1UyN791hIe9Vq58I9VXHurykYSPtXMFcz9fTCLarO9Vfn7kfGqiHAR0kdOaKtx+ljgGbPCqQsoAhnrzmaE4EdHAbmR0XzdEplLVXLKGipiI+Byb8oSSCDKte55mC3QpI15tHeYQFZ3eOLi4VJcqx4fuEAzdBCq7Ac0NExiC4eokhSk+PCxQBlz4vkYf5D8r6N0iPIFiIS/N3bHScu7ejQi3o99OSMKIVdp2cW4fsuc216iFz4XZMqXlHwYcSTpmhxYiR6Y31fGtFXX5X33BRhyiTsjxA2iBlSCCwpV9C3C8kYkQDqrPDOndNjI0V3WXGA+HksW3Z9iCGx0NXImrUBKtG9nURyrjuaaupy5vBP83ky+Aj27yBfGCIpCtIjYWIjNmr6skB8dyN6KJl3oc5DTSAhoR4uMHH/r/kHAbyKbVUsNb6hhW0dNTQ9GGimxuBtJpR6UG28xcwqe42XNKMrQccrbYBZghqy2e9DvG8/7NaEtVGOQ1I5kLDux/QEOJ8OtJVgGl8pQWBsrPZFEBAUKeM1ufBSRhKRZslZAo59HvRymSSeVdikh8acYyz6taOwAST//YXX5CCwwa7zc6T1fIL4fc= + on: + tags: true + repo: Brightspace/eslint-config-brightspace + all_branches: true diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8754ed6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ +Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2015 D2L Corporation + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 7213a5b..cb6ec0f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,58 @@ # eslint-config-brightspace +[![NPM version][npm-image]][npm-url] +[![Build status][ci-image]][ci-url] +[![Dependency Status][dependencies-image]][dependencies-url] + Common Brightspace eslint configs. + +## Installation + +```shell +npm install eslint-config-brightspace +``` + +## Usage + +Simply specify the `extends` property in the `.eslintrc` file as shown below. **Note:** omit the "eslint-config" when specifying the module, since eslint assumes it. + +### Default Config + +Specify the `extends` property in the `.eslintrc` file: + +```javascript +{ + "extends": "brightspace", + ... +} +``` + +### React Config + +Specify the `react-config` config for the `extends` property: + +```javascript +{ + "extends": "brightspace/react-config", + ... +} +``` + +The [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react) plugin is included witht this configuration, which enables use of the rules it provides. + + +See the [eslint rules](http://eslint.org/docs/rules/) for more details on rule configuration. See the [eslint shareable configs](http://eslint.org/docs/developer-guide/shareable-configs.html) for more details on creating configs. + +## Contributing + +Contributions are welcome, please submit a pull request! + +### Code Style + +This repository is configured with [EditorConfig](http://editorconfig.org) rules and contributions should make use of them. + +[npm-url]: https://npmjs.org/package/eslint-config-brightspace +[npm-image]: https://img.shields.io/npm/v/eslint-config-brightspace.svg +[ci-image]: https://travis-ci.org/Brightspace/eslint-config-brightspace.svg?branch=master +[ci-url]: https://travis-ci.org/Brightspace/eslint-config-brightspace +[dependencies-url]: https://david-dm.org/brightspace/eslint-config-brightspace +[dependencies-image]: https://img.shields.io/david/Brightspace/eslint-config-brightspace.svg diff --git a/common-config.js b/common-config.js new file mode 100644 index 0000000..06b7134 --- /dev/null +++ b/common-config.js @@ -0,0 +1,33 @@ + +// nr = not as per eslint:recommended + +module.exports = { + "rules": { + "comma-spacing": 2, // nr + "eol-last": 2, // nr + "eqeqeq": 2, // nr + "indent": [2, "tab", { "SwitchCase": 1 }], // nr + "new-parens": 2, // nr + "no-debugger": 2, + "no-dupe-args": 2, + "no-dupe-keys": 2, + "no-duplicate-case": 2, + "no-ex-assign": 2, + "no-fallthrough": 2, + "no-invalid-this": 2, // nr + "no-multiple-empty-lines": [2, {"max": 1}], // nr + "no-trailing-spaces": 2, // nr + "no-undef": 2, + "no-unreachable": 2, + "no-unused-vars": [2, {"vars": "all", "args": "after-used"}], + "quotes": [2, "single", "avoid-escape"], // nr + "semi": 2, // nr + "space-after-keywords": 2, // nr + "space-before-blocks": [2, "always"], // nr + "space-before-function-paren": [2, "never"], //nr + "space-infix-ops": 2, // nr + "space-return-throw-case": 2, // nr + "strict": [2, "global"], // nr + "valid-typeof": 2 + } +}; diff --git a/index.js b/index.js new file mode 100644 index 0000000..7103606 --- /dev/null +++ b/index.js @@ -0,0 +1,7 @@ +var eslint = require('eslint'), + extend = require('extend'), + commonConfig = require('./common-config'); + +var recommendedConfig = eslint.linter.defaults(); + +module.exports = extend(true, recommendedConfig, commonConfig); diff --git a/package.json b/package.json new file mode 100644 index 0000000..68dcb01 --- /dev/null +++ b/package.json @@ -0,0 +1,30 @@ +{ + "name": "eslint-config-brightspace", + "version": "0.0.1", + "description": "Common Brightspace eslint configs.", + "main": "index.js", + "scripts": { + "test": "exit 0" + }, + "repository": { + "type": "git", + "url": "https://github.com/Brightspace/eslint-config-brightspace.git" + }, + "keywords": [ + "d2l", + "eslint", + "eslintconfig" + ], + "author": "D2L Corporation", + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/Brightspace/eslint-config-brightspace/issues" + }, + "homepage": "https://github.com/Brightspace/eslint-config-brightspace", + "devDependencies": {}, + "dependencies": { + "eslint": "^1.5.1", + "eslint-plugin-react": "^3.5.0", + "extend": "^3.0.0" + } +} diff --git a/react-config.js b/react-config.js new file mode 100644 index 0000000..f896e67 --- /dev/null +++ b/react-config.js @@ -0,0 +1,19 @@ +var baseConfig = require('./index'), + extend = require('extend'); + +var reactConfig = { + "ecmaFeatures": { + "jsx": true + }, + "env": { + "browser": true, + "es6": true, + "jest": true, + "node": true + }, + "plugins": [ + "react" + ] +}; + +module.exports = extend(true, baseConfig, reactConfig);