Skip to content

Commit

Permalink
Switch to yarn (palantir#1980)
Browse files Browse the repository at this point in the history
  • Loading branch information
adidahiya authored and nchen63 committed Jan 4, 2017
1 parent 6dcf3f0 commit 9df7579
Show file tree
Hide file tree
Showing 5 changed files with 1,129 additions and 28 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ tslint accepts the following command-line options:
--force:
Return status code 0 even if there are any lint errors.
Useful while running as npm script.
Useful while running TSLint via an npm script.
-i, --init:
Generates a tslint.json config file in the current working directory.
Expand Down Expand Up @@ -387,20 +387,25 @@ Development
-----------
<sup>[back to ToC &uarr;](#table-of-contents)</sup>

Requirements:

- `node` v7
- `yarn` v0.18

#### Quick Start

```bash
git clone [email protected]:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf
npm install
npm run compile
npm run test
yarn install
yarn compile
yarn test
```

#### `next` branch

The [`next` branch of this repo](https://github.com/palantir/tslint/tree/next) tracks the latest TypeScript compiler
nightly release as a `peerDependency`. This allows you to develop the linter and its rules against the latest features of the
language. Releases from this branch are published to npm with the `next` dist-tag, so you may install the latest dev
language. Releases from this branch are published to NPM with the `next` dist-tag, so you may install the latest dev
version of TSLint via `npm install tslint@next`.

Creating a new release
Expand All @@ -409,7 +414,7 @@ Creating a new release

1. Bump the version number in `package.json` and `src/tslintMulti.ts`
2. Add release notes in `CHANGELOG.md`
3. `npm run verify` to build the latest sources
3. `yarn verify` to build the latest sources
4. Commit with message `Prepare release <version>`
5. Run `npm publish`
6. Create a git tag for the new release and push it ([see existing tags here](https://github.com/palantir/tslint/tags))
16 changes: 8 additions & 8 deletions docs/_data/rules.json
Original file line number Diff line number Diff line change
Expand Up @@ -1566,14 +1566,6 @@
"type": "typescript",
"typescriptOnly": true
},
{
"ruleName": "unified-signatures",
"description": "Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.",
"optionsDescription": "Not configurable.",
"options": null,
"type": "typescript",
"typescriptOnly": true
},
{
"ruleName": "typeof-compare",
"description": "Makes sure result of `typeof` is compared to correct string values",
Expand All @@ -1583,6 +1575,14 @@
"type": "functionality",
"typescriptOnly": false
},
{
"ruleName": "unified-signatures",
"description": "Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.",
"optionsDescription": "Not configurable.",
"options": null,
"type": "typescript",
"typescriptOnly": true
},
{
"ruleName": "use-isnan",
"description": "Enforces use of the `isNaN()` function to check for NaN references instead of a comparison to the `NaN` constant.",
Expand Down
8 changes: 4 additions & 4 deletions docs/develop/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ To develop TSLint simply clone the repository and install dependencies:

```bash
git clone [email protected]:palantir/tslint.git --config core.autocrlf=input --config core.eol=lf
npm install
npm run compile
npm run test
yarn install
yarn compile
yarn test
```

#### `next` branch

The [`next` branch of the TSLint repo](https://github.com/palantir/tslint/tree/next) tracks the latest TypeScript
compiler as a `devDependency`. This allows you to develop the linter and its rules against the latest features of the
language. Releases from this branch are published to npm with the `next` dist-tag, so you can get the latest dev
language. Releases from this branch are published to NPM with the `next` dist-tag, so you can get the latest dev
version of TSLint via `npm install tslint@next`.
20 changes: 10 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,31 +45,31 @@
"underscore.string": "^3.3.4",
"update-notifier": "^1.0.2"
},
"peerDependencies": {
"typescript": ">=2.0.0"
},
"devDependencies": {
"@types/babel-code-frame": "^6.20.0",
"@types/chai": "^3.4.34",
"@types/colors": "^0.6.33",
"@types/diff": "0.0.31",
"@types/findup-sync": "^0.3.29",
"@types/glob": "^5.0.30",
"@types/js-yaml": "^3.5.28",
"@types/mocha": "^2.2.32",
"@types/node": "^6.0.45",
"@types/js-yaml": "^3.5.29",
"@types/mocha": "^2.2.35",
"@types/node": "^6.0.56",
"@types/optimist": "0.0.29",
"@types/resolve": "0.0.4",
"@types/underscore": "^1.7.33",
"@types/underscore": "^1.7.36",
"@types/underscore.string": "0.0.30",
"chai": "^3.0.0",
"js-yaml": "^3.6.1",
"mocha": "^3.1.0",
"chai": "^3.5.0",
"js-yaml": "^3.7.0",
"mocha": "^3.2.0",
"npm-run-all": "^3.1.0",
"rimraf": "^2.5.4",
"tslint": "latest",
"tslint-test-config-non-relative": "file:test/external/tslint-test-config-non-relative",
"typescript": "2.1.4"
},
"peerDependencies": {
"typescript": ">=2.0.0"
},
"license": "Apache-2.0"
}
Loading

0 comments on commit 9df7579

Please sign in to comment.