Skip to content
This repository has been archived by the owner on Oct 30, 2024. It is now read-only.

Rename packages (nyc -> coverage, prettier -> format, tsc -> typescript) #27

Merged
merged 2 commits into from
May 19, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
15 changes: 5 additions & 10 deletions packages/coverage/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,29 @@
# @ethereumjs/config-nyc
# @ethereumjs/config-coverage

Common test coverage configuration for `EthereumJS` libraries.

Tool: [nyc](https://istanbul.js.org/)

Supported Version: `^11.7.0`

Exposed CLI commands:
Exposed CLI command:

- `ethereumjs-config-coverage`
- `ethereumjs-config-coveralls`

## Usage

Add `.nycrc`:

```json
{
"extends": "@ethereumjs/config-nyc"
"extends": "@ethereumjs/config-coverage"
}
```

Use CLI commands above in `package.json`:
Use scipt above in `package.json`:

```json
"scripts": {
"coverage": "ethereumjs-config-coverage",
"coveralls": "ethereumjs-config-coveralls"
"coverage": "ethereumjs-config-coverage"
}
```



8 changes: 4 additions & 4 deletions packages/ethereumjs-config-tslint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ Use CLI commands above in `package.json`:

```json
"scripts": {
"tslint": "ethereumjs-config-tslint",
"tslint-fix": "ethereumjs-config-tslint-fix",
"lint": "ethereumjs-config-lint",
"lint-fix": "ethereumjs-config-lint-fix"
"tslint": "ethereumjs-config-tslint",
"tslint:fix": "ethereumjs-config-tslint --fix",
"lint": "ethereumjs-config-lint",
"lint:fix": "ethereumjs-config-lint --fix"
}
```

Expand Down
7 changes: 2 additions & 5 deletions packages/format/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @ethereumjs/config-prettier
# @ethereumjs/config-format

Common formatting configuration for `EthereumJS` libraries.

Expand All @@ -16,7 +16,7 @@ Exposed CLI commands:
Add `prettier.config.js`:

```javascript
module.exports = require('@ethereumjs/config-prettier')
module.exports = require('@ethereumjs/config-format')
```

Add `.prettierignore`:
Expand All @@ -37,6 +37,3 @@ Use CLI commands above in `package.json`:
"format-fix": "ethereumjs-config-format-fix"
}
```



14 changes: 7 additions & 7 deletions packages/typescript/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @ethereumjs/config-tsc
# @ethereumjs/config-typescript

Common `TypeScript` configuration for `EthereumJS` libraries.

Expand All @@ -8,16 +8,16 @@ Supported Version: `^3.2.2`

Exposed CLI commands:

- `ethereumjs-config-tsc`
- `ethereumjs-config-build`
- `ethereumjs-config-ts-compile`
- `ethereumjs-config-ts-build`

## Usage

Add `tsconfig.json`:

```json
{
"extends": "@ethereumjs/config-tsc",
"extends": "@ethereumjs/config-typescript",
"include": ["src/**/*.ts", "test/**/*.ts"]
}
```
Expand All @@ -26,7 +26,7 @@ Add `tsconfig.prod.json`:

```json
{
"extends": "@ethereumjs/config-tsc",
"extends": "@ethereumjs/config-typescript",
"compilerOptions": {
"outDir": "./dist"
},
Expand All @@ -38,8 +38,8 @@ Use CLI commands above in `package.json`:

```json
"scripts": {
"tsc": "ethereumjs-config-tsc",
"build": "ethereumjs-config-build"
"tsc": "ethereumjs-config-ts-compile",
"build": "ethereumjs-config-ts-build"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great!

}
```

Expand Down
4 changes: 2 additions & 2 deletions packages/typescript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
"cli"
],
"bin": {
"ethereumjs-config-tsc": "./cli/tsc.sh",
"ethereumjs-config-build": "./cli/build.sh"
"ethereumjs-config-ts-compile": "./cli/ts-compile.sh",
"ethereumjs-config-ts-build": "./cli/ts-build.sh"
},
"publishConfig": {
"access": "public"
Expand Down