Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# godaddy-style

Official GoDaddy JavaScript styleguide. It includes `eslint` packages for three use-cases and can be used as a standard in any new project.
Official GoDaddy JavaScript styleguide. It includes `eslint` packages for various use-cases and can be used as a standard in any new project.

- [`eslint-config-godaddy`]: Base configuration for _non-React_, ES6 JavaScript applications
- [`eslint-config-godaddy-react`]: Configuration for ES6 React JavaScript applications
- [`eslint-config-godaddy-es5`]: Configuration for React _and_ non-React ES5 JavaScript applications
- [`eslint-config-godaddy-typescript`]: Configuration for ES6 TypeScript applications
- [`eslint-config-godaddy-react-typescript`]: Configuration for ES6 React JavaScript applications
- [`eslint-config-godaddy-flow`]: Configuration for ES6 React JavaScript applications using Flow
- [`eslint-config-godaddy-react-flow`]: Configuration for ES6 React JavaScript applications using Flow

There are many useful features:
Expand Down Expand Up @@ -36,6 +39,15 @@ npm i eslint-config-godaddy-react --save-dev
# OR (legacy ES5 with React rules)
npm i eslint-config-godaddy-es5 --save-dev

# OR (ES6 with TypeScript rules)
npm i eslint-config-godaddy-typescript --save-dev

# OR (ES6 with React and TypeScript rules)
npm i eslint-config-godaddy-react-typescript --save-dev

# OR (ES6 with Flow rules)
npm i eslint-config-godaddy-flow --save-dev

# OR (ES6 with React and Flow rules)
npm i eslint-config-godaddy-react-flow --save-dev
```
Expand Down Expand Up @@ -142,4 +154,7 @@ No problem. Reach out to us by [opening an issue]
[`eslint-config-godaddy`]: /packages/eslint-config-godaddy
[`eslint-config-godaddy-react`]: /packages/eslint-config-godaddy-react
[`eslint-config-godaddy-es5`]: /packages/eslint-config-godaddy-es5
[`eslint-config-godaddy-typescript`]: /packages/eslint-config-godaddy-typescript
[`eslint-config-godaddy-react-typescript`]: /packages/eslint-config-godaddy-react-typescript
[`eslint-config-godaddy-flow`]: /packages/eslint-config-godaddy-react-flow
[`eslint-config-godaddy-react-flow`]: /packages/eslint-config-godaddy-react-flow
164 changes: 164 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 13 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,22 @@
"description": "The approach to JavaScript at GoDaddy. We think it's pretty decent.",
"scripts": {
"lint": "eslint -c .eslintrc.js packages/**/*.js",
"postinstall": "run-p install:config install:config:es5 install:config:react install:config:react-flow",
"postinstall": "run-p install:config install:config:es5 install:config:flow install:config:react install:config:react-flow install:config:typescript install:config:react-typescript",
"install:config": "cd packages/eslint-config-godaddy && npm install",
"install:config:es5": "cd packages/eslint-config-godaddy-es5 && npm install",
"install:config:flow": "cd packages/eslint-config-godaddy-flow && npm install",
"install:config:react": "cd packages/eslint-config-godaddy-react && npm install",
"install:config:react-flow": "cd packages/eslint-config-godaddy-react-flow && npm install",
"test": "run-p lint test:config test:config:es5 test:config:react test:config:react-flow",
"install:config:typescript": "cd packages/eslint-config-godaddy-typescript && npm install",
"install:config:react-typescript": "cd packages/eslint-config-godaddy-react-typescript && npm install",
"test": "run-p lint test:config test:config:es5 test:config:flow test:config:react test:config:react-flow test:config:typescript test:config:react-typescript",
"test:config": "cd packages/eslint-config-godaddy && npm test",
"test:config:es5": "cd packages/eslint-config-godaddy-es5 && npm test",
"test:config:flow": "cd packages/eslint-config-godaddy-flow && npm test",
"test:config:react": "cd packages/eslint-config-godaddy-react && npm test",
"test:config:react-flow": "cd packages/eslint-config-godaddy-react-flow && npm test",
"test:config:typescript": "cd packages/eslint-config-godaddy-typescript && npm test",
"test:config:react-typescript": "cd packages/eslint-config-godaddy-react-typescript && npm test",
"prepush": "npm test"
},
"prepush": {
Expand All @@ -28,6 +34,7 @@
"keywords": [
"godaddy",
"javascript",
"typescript",
"lint",
"styleguide",
"style-guide",
Expand All @@ -50,6 +57,8 @@
"godaddy-js-style-eslint": "./bin/eslint"
},
"devDependencies": {
"@typescript-eslint/eslint-plugin": "^2.3.1",
"@typescript-eslint/parser": "^2.3.1",
"babel-eslint": "^10.0.2",
"eslint": "^6.0.1",
"eslint-find-rules": "^3.3.1",
Expand All @@ -60,7 +69,8 @@
"eslint-plugin-mocha": "^5.3.0",
"eslint-plugin-react": "^7.14.2",
"prepush": "^3.1.11",
"react": "^16.8.6"
"react": "^16.8.6",
"typescript": "^3.0"
},
"dependencies": {
"npm-run-all": "^4.0.2"
Expand Down
Loading