From c700046b7673a0f470c8d8abeec3cf873049a78a Mon Sep 17 00:00:00 2001 From: Leonid Logvinov Date: Thu, 4 Jan 2018 12:54:16 +0100 Subject: Apply prettify on json and md files --- packages/tslint-config/CHANGELOG.md | 12 +++--- packages/tslint-config/README.md | 10 ++--- packages/tslint-config/package.json | 80 ++++++++++++++++-------------------- packages/tslint-config/tsconfig.json | 24 +++++------ 4 files changed, 57 insertions(+), 69 deletions(-) (limited to 'packages/tslint-config') diff --git a/packages/tslint-config/CHANGELOG.md b/packages/tslint-config/CHANGELOG.md index daea1975c..1d56bca5b 100644 --- a/packages/tslint-config/CHANGELOG.md +++ b/packages/tslint-config/CHANGELOG.md @@ -1,15 +1,15 @@ # CHANGELOG -v0.4.0 - _December 28, 2017_ ------------------------- +## v0.4.0 - _December 28, 2017_ + * Added custom 'underscore-privates' rule, requiring underscores to be prepended to private variable names * Because our tools can be used in both a TS and JS environment, we want to make the private methods of any public facing interface show up at the bottom of auto-complete lists. Additionally, we wanted to remain consistent with respect to our usage of underscores in order to enforce this rule with a linter rule, rather then manual code reviews. -v0.3.0 - _December 20, 2017_ ------------------------- +## v0.3.0 - _December 20, 2017_ + * Added rules for unused imports, variables and Async suffixes (#265) -v0.1.0 - _Nov. 14, 2017_ ------------------------- +## v0.1.0 - _Nov. 14, 2017_ + * Re-published TsLintConfig previously published under NPM package `tslint-config-0xproject` * Updated to TSLint v5.8.0, requiring several rule additions to keep our conventions aligned. diff --git a/packages/tslint-config/README.md b/packages/tslint-config/README.md index b27d05df0..8a6fa8a2f 100644 --- a/packages/tslint-config/README.md +++ b/packages/tslint-config/README.md @@ -1,5 +1,4 @@ -@0xproject/tslint-config ------- +## @0xproject/tslint-config TSLint configuration and custom linter rules used by 0xProject. @@ -12,11 +11,10 @@ yarn add --dev @0xproject/tslint-config ## Usage Add the following to your `tslint.json` file + ```json { - "extends": [ - "@0xproject/tslint-config" - ] + "extends": ["@0xproject/tslint-config"] } ``` @@ -29,11 +27,13 @@ Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting ### Install Dependencies If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: + ```bash yarn config set workspaces-experimental true ``` Then install dependencies + ```bash yarn install ``` diff --git a/packages/tslint-config/package.json b/packages/tslint-config/package.json index 0b99332e7..17b9ebc1e 100644 --- a/packages/tslint-config/package.json +++ b/packages/tslint-config/package.json @@ -1,47 +1,37 @@ { - "name": "@0xproject/tslint-config", - "version": "0.4.0", - "description": "Lint rules related to 0xProject for TSLint", - "main": "tslint.json", - "scripts": { - "build": "tsc", - "clean": "shx rm -rf lib", - "lint": "tslint --project . 'rules/**/*.ts'" - }, - "files": [ - "tslint.js", - "README.md", - "LICENSE" - ], - "repository": { - "type": "git", - "url": "git://github.com/0xProject/0x.js.git" - }, - "keywords": [ - "tslint", - "config", - "0xProject", - "typescript", - "ts" - ], - "author": { - "name": "Fabio Berger", - "email": "fabio@0xproject.com" - }, - "license": "Apache-2.0", - "bugs": { - "url": "https://github.com/0xProject/0x.js/issues" - }, - "homepage": "https://github.com/0xProject/0x.js/packages/tslint-config/README.md", - "devDependencies": { - "@types/lodash": "^4.14.86", - "shx": "^0.2.2", - "tslint": "5.8.0", - "tslint-eslint-rules": "^4.1.1", - "typescript": "~2.6.1" - }, - "dependencies": { - "lodash": "^4.17.4", - "tslint-react": "^3.2.0" - } + "name": "@0xproject/tslint-config", + "version": "0.4.0", + "description": "Lint rules related to 0xProject for TSLint", + "main": "tslint.json", + "scripts": { + "build": "tsc", + "clean": "shx rm -rf lib", + "lint": "tslint --project . 'rules/**/*.ts'" + }, + "files": ["tslint.js", "README.md", "LICENSE"], + "repository": { + "type": "git", + "url": "git://github.com/0xProject/0x.js.git" + }, + "keywords": ["tslint", "config", "0xProject", "typescript", "ts"], + "author": { + "name": "Fabio Berger", + "email": "fabio@0xproject.com" + }, + "license": "Apache-2.0", + "bugs": { + "url": "https://github.com/0xProject/0x.js/issues" + }, + "homepage": "https://github.com/0xProject/0x.js/packages/tslint-config/README.md", + "devDependencies": { + "@types/lodash": "^4.14.86", + "shx": "^0.2.2", + "tslint": "5.8.0", + "tslint-eslint-rules": "^4.1.1", + "typescript": "~2.6.1" + }, + "dependencies": { + "lodash": "^4.17.4", + "tslint-react": "^3.2.0" + } } diff --git a/packages/tslint-config/tsconfig.json b/packages/tslint-config/tsconfig.json index 7661a9d07..77ddf892f 100644 --- a/packages/tslint-config/tsconfig.json +++ b/packages/tslint-config/tsconfig.json @@ -1,15 +1,13 @@ { - "compilerOptions": { - "module": "commonjs", - "target": "es5", - "lib": [ "es2017", "dom"], - "outDir": "lib", - "sourceMap": true, - "declaration": true, - "noImplicitAny": true, - "strictNullChecks": true - }, - "include": [ - "./rules/**/*" - ] + "compilerOptions": { + "module": "commonjs", + "target": "es5", + "lib": ["es2017", "dom"], + "outDir": "lib", + "sourceMap": true, + "declaration": true, + "noImplicitAny": true, + "strictNullChecks": true + }, + "include": ["./rules/**/*"] } -- cgit v1.2.3