Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix linter README #656

Merged
merged 1 commit into from
Mar 20, 2020
Merged

Fix linter README #656

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 4 additions & 5 deletions packages/linter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ Command-line (local build):
```sh
# from the amp-toolbox root
$ npm install
$ npm run build # generates packages/linter/src/cli.js
$ npm run build # generates packages/linter/dist/cli.js
$ cd packages/linter
$ node src/cli.js https://amp.dev/
$ node dist/cli.js https://amp.dev/
```

Command-line (from npm):
Expand Down Expand Up @@ -57,13 +57,12 @@ performed.

These scripts can be invoked in the usual way by `npm run XXX` if `npm install`
is run in this directory. They can also be invoked from the `amp-toolbox` root
directory without installing locally by `lerna run --scope '*/toolbox-linter'
XXX`. (lerna sets the `PATH` so that the required binaries are available.)
directory without installing locally by `lerna run --scope '*/toolbox-linter' XXX`. (lerna sets the `PATH` so that the required binaries are available.)

#### `build`

Populates the `dist` directory with the appropriate `*.js` and `*.d.ts` files.
Note that tests are *not* included. This script is intended to be used when
Note that tests are _not_ included. This script is intended to be used when
building the npm package.

#### `transpile`
Expand Down