From fddc59fbc57dd84b6cd9d87dc1ca0324febe4027 Mon Sep 17 00:00:00 2001 From: Michael Novotny Date: Mon, 20 Sep 2021 13:45:02 -0500 Subject: [PATCH] Lowercases license and readme file names. --- LICENSE | 21 ------------- README.md | 94 ------------------------------------------------------- 2 files changed, 115 deletions(-) delete mode 100644 LICENSE delete mode 100644 README.md diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 570b7dd5..00000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2016 Michael Novotny - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md deleted file mode 100644 index 8e91812c..00000000 --- a/README.md +++ /dev/null @@ -1,94 +0,0 @@ -# eslint-config-get-off-my-lawn - -> A highly opinionated, [sharable config](http://eslint.org/docs/developer-guide/shareable-configs.html) of [ESLint](http://eslint.org) rules to produce beautiful, readable JavaScript. - -![eslint-config-get-off-my-lawn](.github/logo.jpg) - -As developers, we spend more time reading code than writing it. These rules aim to make reading JavaScript a priority. - -That means some rules will feel oppressive or "over the top" for many developers, which is fine. If you don't like it, you can get off my lawn! ... Or extend the rules and override them with the ones that bother you. Either way. 😊 - -This config also comes with the following plugins, and corresponding rules, baked in. - -- [eslint](https://www.npmjs.com/package/eslint) -- [eslint-plugin-eslint-comments](https://www.npmjs.com/package/eslint-plugin-eslint-comments) -- [eslint-plugin-get-off-my-lawn](https://www.npmjs.com/package/eslint-plugin-get-off-my-lawn) -- [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import) -- [eslint-plugin-jest](https://www.npmjs.com/package/eslint-plugin-jest) -- [eslint-plugin-json](https://www.npmjs.com/package/eslint-plugin-json) -- [eslint-plugin-jsx-a11y](https://www.npmjs.com/package/eslint-plugin-jsx-a11y) -- [eslint-plugin-node](https://www.npmjs.com/package/eslint-plugin-node) -- [eslint-plugin-objects](https://www.npmjs.com/package/eslint-plugin-objects) -- [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react) -- [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks) -- [eslint-plugin-react-native](https://www.npmjs.com/package/eslint-plugin-react-native) -- [eslint-plugin-security](https://www.npmjs.com/package/eslint-plugin-security) -- [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn) - -Each and every single rule has been meticulously poured over and purposefully hand picked or excluded. - -eslint-config-get-off-my-lawn will automatically enable and disable plugins (and thus rules) based on your `package.json` dependencies. Not using React? Cool. eslint-plugin-jsx-a11y, eslint-plugin-react, eslint-plugin-react-hooks, and eslint-plugin-react-native won't be included. Not using a React version that supports hooks? eslint-plugin-react-hooks will be disabled. Not a React Native project? No problem. Those rules won't be included. I think you get the idea... 😉 - -## Install - -### NPM - -``` -$ npm i eslint eslint-config-get-off-my-lawn --save-dev -``` - -### Yarn - -``` -$ yarn add eslint eslint-config-get-off-my-lawn --dev -``` - -## Usage - -Create an ESLint config in your `package.json` or `.eslintrc.js` file. - -### package.json - -```json -{ - "name": "my-awesome-project", - "eslintConfig": { - "extends": "get-off-my-lawn", - "rules": { - // enable additional rules, override rule options, or disable rules - } - } -} -``` - -### .eslintrc.js - -```js -module.exports = { - extends: 'get-off-my-lawn', - rules: { - // enable additional rules, override rule options, or disable rules - }, -}; -``` - -Once your rules are configured, we recommend running the following command in your `package.json` as an [npm script](https://docs.npmjs.com/cli/v7/using-npm/scripts). - -``` -eslint . --ext .js --ext .json -``` - -## Usage With Prettier - -Love eslint-config-get-off-my-lawn? Love [prettier](https://prettier.io/)? Well you're in luck! - -eslint-config-get-off-my-lawn will automatically detect if your project is using prettier and it will apply [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) to turn off all rules that are unnecessary or might conflict with prettier. - -## Related - -- [prettier-config-get-off-my-lawn](https://www.npmjs.com/package/prettier-config-get-off-my-lawn) - A highly opinionated, [sharable config](https://prettier.io/docs/en/configuration.html#sharing-configurations) of Prettier rules to produce beautiful, readable code. -- [stylelint-config-get-off-my-lawn](https://www.npmjs.com/package/stylelint-config-get-off-my-lawn) - A highly opinionated, [sharable config](https://github.com/stylelint/stylelint/blob/master/docs/user-guide/configuration.md#extends) of [stylelint](http://stylelint.io) rules to produce beautiful, readable CSS and Sass. - -## License - -MIT © [Michael Novotny](http://manovotny.com)