Merge pull request #1 from spacetabs/readme-changes

Base, eslint, stylelint readme files.
spacetab-io · Nov 27, 2019 · 0b0e4ba · 0b0e4ba
2 parents f92d35c + 871d7fc
commit 0b0e4ba
Show file tree

Hide file tree

Showing 3 changed files with 138 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -66,7 +66,7 @@ After previous operations add this to your eslint configuration.
 }
 ```
 
-[⬆ Go top](#content)
+[⬆ Go top](#linting-configs-by-spacetabio)
 
 ------
 
@@ -88,13 +88,13 @@ Next, install all peer dependencies. The easiest way is to add this lines to you
 }
 ```
 
+After previous operations add this to your eslint configuration.
 ```json
 {
   "extends": ["@spacetabs/stylelint-config-spacetab-io"]
 }
 ```
 
-After previous operations add this to your eslint configuration.
 **PROFIT!** Now you can use our stylelint configuration in your awesome projects!
 
-[⬆ Go top](#content)
+[⬆ Go top](#linting-configs-by-spacetabio)
diff --git a/packages/eslint-config-spacetab-io/README.md b/packages/eslint-config-spacetab-io/README.md
@@ -3,10 +3,108 @@
 > Programs must be written for people to read, and only incidentally for machines to execute. 
 > ###### Harold Abelson
 
-Here we have 3 configs:
-- base config (vue linting, typescript, javascript linting)
-- only vue-html linting
-- only typescript linting
-- only javascript linting
+#### Content:
+- [⚙ Eslint config integration](#eslint-config-integration)
+- [◉ Eslint config options](#eslint-config-options)
 
-Also, If you have typescript and javascript `.vue` files. You can change the extension from `.vue` to `.js.vue`. Linter will check code in these components like a javascript.
+
+## Eslint config integration
+
+First, what you need is to install npm package.
+```bash
+npm install --save-dev @spacetabs/eslint-config-spacetab-io
+```
+
+Next, install all peer dependencies. The easiest way is to add this lines to your `devDependensies`
+```json
+{
+  "eslint": "^6.6.0",
+  "@typescript-eslint/parser": "^2.9.0",
+  "eslint-plugin-import": "^2.18.2",
+  "eslint-plugin-simple-import-sort": "^4.0.0",
+  "eslint-plugin-vue": "^6.0.0",
+  "@typescript-eslint/eslint-plugin": "^2.6.1",
+  "@vue/eslint-config-typescript": "^4.0.0",
+  "vue-eslint-parser": "^7.0.0",
+  "typescript": "^3.6.4",
+  "babel-eslint": "^10.0.3"
+}
+```
+
+After previous operations add this to your eslint configuration.
+```json
+{
+  "extends": [
+    "@spacetabs/eslint-config-spacetab-io"
+  ],
+  "parserOptions": {
+    "project": "./tsconfig.json",
+    "sourceType": "module",
+    "extraFileExtensions": [".vue"]
+  }
+}
+```
+**PROFIT!** Now you can use our eslint configuration in your awesome projects!
+
+> Minimal eslint configuration example 
+```json
+{
+  "root": true,
+  "parserOptions": {
+    "project": "./tsconfig.json",
+    "sourceType": "module",
+    "extraFileExtensions": [".vue"]
+  },
+  "extends": [
+    "@spacetabs/eslint-config-spacetab-io"
+  ]
+}
+```
+
+[⬆ Go top](#eslint-config-by-spacetabio)
+
+---
+
+## Eslint config options
+
+### Here we have 3 configs:
+
+#### base
+- vue linting
+- typescript
+- javascript linting
+
+Usage:
+```json
+{
+  "extends": ["@spacetabs/eslint-config-spacetab-io"]
+}
+```
+
+> Also, If you have typescript and javascript `.vue` files. You can change the extension from `.vue` to `.js.vue`. Linter will check code in these components like a javascript.
+
+#### only vue html
+Usage:
+```json
+{
+  "extends": ["@spacetabs/eslint-config-spacetab-io/vue-html"]
+}
+```
+
+#### only typescript
+Usage:
+```json
+{
+  "extends": ["@spacetabs/eslint-config-spacetab-io/typescript"]
+}
+```
+
+#### only javascript
+Usage:
+```json
+{
+  "extends": ["@spacetabs/eslint-config-spacetab-io/javascript"]
+}
+```
+
+[⬆ Go top](#eslint-config-by-spacetabio)
diff --git a/packages/stylelint-config-spacetab-io/README.md b/packages/stylelint-config-spacetab-io/README.md
@@ -2,3 +2,34 @@
 
 > if you can write "hello world" you can change the world
 > ###### Raghu Venkatesh
+
+
+## Stylelint config integration
+
+First, what you need is to install npm package.
+```bash
+npm install --save-dev @spacetabs/eslint-config-spacetab-io
+```
+
+Next, install all peer dependencies. The easiest way is to add this lines to your `devDependensies`
+```json
+{
+  "stylelint": "^10.1.0",
+  "stylelint-config-recess-order": "^2.0.3",
+  "stylelint-config-standard": "^18.3.0",
+  "stylelint-declaration-use-variable": "^1.7.0",
+  "stylelint-scss": "^3.9.3"
+}
+```
+
+After previous operations add this to your eslint configuration.
+```json
+{
+  "extends": ["@spacetabs/stylelint-config-spacetab-io"]
+}
+```
+
+**PROFIT!** Now you can use our stylelint configuration in your awesome projects!
+
+
+[⬆ Go top](#stylelint-config-by-spacetabio)