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 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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
package-lock.json
6 changes: 2 additions & 4 deletions lerna.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"packages": [
"packages/*"
],
"version": "1.1.1"
"packages": ["packages/*"],
"version": "2.0.0"
}
29 changes: 29 additions & 0 deletions packages/coverage/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# @ethereumjs/config-coverage

Common test coverage configuration for `EthereumJS` libraries.

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

Supported Version: `^11.7.0`

Exposed CLI command:

- `ethereumjs-config-coverage`

## Usage

Add `.nycrc`:

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

Use scipt above in `package.json`:

```json
"scripts": {
"coverage": "ethereumjs-config-coverage"
}
```
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ethereumjs/config-nyc",
"version": "1.1.1",
"name": "@ethereumjs/config-coverage",
"version": "2.0.0",
"main": "nyc.json",
"license": "MIT",
"repository": "git@github.com:ethereumjs/ethereumjs-config.git",
Expand All @@ -10,8 +10,7 @@
"cli"
],
"bin": {
"ethereumjs-config-coverage": "./cli/coverage.sh",
"ethereumjs-config-coveralls": "./cli/coveralls.sh"
"ethereumjs-config-coverage": "./cli/coverage.sh"
},
"publishConfig": {
"access": "public"
Expand Down
34 changes: 0 additions & 34 deletions packages/ethereumjs-config-nyc/README.md

This file was deleted.

3 changes: 0 additions & 3 deletions packages/ethereumjs-config-nyc/cli/coveralls.sh

This file was deleted.

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
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"
}
```



Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ethereumjs/config-prettier",
"version": "1.1.1",
"name": "@ethereumjs/config-format",
"version": "2.0.0",
"main": "prettier.json",
"license": "MIT",
"repository": "git@github.com:ethereumjs/ethereumjs-config.git",
Expand Down
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ethereumjs/config-tsc",
"version": "1.1.1",
"name": "@ethereumjs/config-typescript",
"version": "2.0.0",
"main": "tsconfig.json",
"license": "MIT",
"repository": "git@github.com:ethereumjs/ethereumjs-config.git",
Expand All @@ -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