diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef7608b8..4a609859 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ At first: Thank you for being interested and using my plugin. :smiley_cat: # Basic steps 1. Create a fork and checkout your fork. -2. Run `./release.sh` or at least the `Cleanup` and `Prepare` steps in this script. +2. Run `pnpm run preflight`. 3. Create an issue for your feature or fix. 4. Create a `Draft` pull request that also references your created issue. diff --git a/README.md b/README.md index e72188c6..5e7e25b5 100644 --- a/README.md +++ b/README.md @@ -63,11 +63,11 @@ pnpm add --save-dev prettier @prettier/plugin-pug ## Usage ```bash -npx prettier --write "**/*.pug" +npx prettier --write "**/*.pug" --plugin="@prettier/plugin-pug" # or -yarn prettier --write "**/*.pug" +yarn prettier --write "**/*.pug" --plugin="@prettier/plugin-pug" # or -pnpm prettier --write "**/*.pug" +pnpm prettier --write "**/*.pug" --plugin="@prettier/plugin-pug" ``` ## Configuration @@ -116,9 +116,7 @@ If you’re interested in contributing to the development of Prettier for Pug, y To run `@prettier/plugin-pug` locally: - Clone this repository. -- Execute `pnpm install`. -- Execute `pnpm run lint` to make sure that the code passes formatting and linting. -- Execute `pnpm run test` to make sure that TypeScript successfully compiles into JavaScript and all unit tests pass. +- Execute `pnpm run preflight`. ## Credits diff --git a/docs/guide/index.md b/docs/guide/index.md index d65aef14..261c3cbf 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -27,15 +27,15 @@ Format all pug files in your project: ::: code-group ```shell [npm] -npx prettier --write "**/*.pug" +npx prettier --write "**/*.pug" --plugin="@prettier/plugin-pug" ``` ```shell [pnpm] -pnpm prettier --write "**/*.pug" +pnpm prettier --write "**/*.pug" --plugin="@prettier/plugin-pug" ``` ```shell [yarn] -yarn prettier --write "**/*.pug" +yarn prettier --write "**/*.pug" --plugin="@prettier/plugin-pug" ``` ::: diff --git a/release.sh b/release.sh deleted file mode 100755 index 1d6467d6..00000000 --- a/release.sh +++ /dev/null @@ -1,34 +0,0 @@ -#!/usr/bin/env bash -set -x - -# Cleanup -rm -Rf coverage -rm -Rf dist -rm -Rf node_modules -rm pnpm-lock.yaml - -set -e - -# Prepare -pnpm install -pnpm run lint -pnpm run test --silent -pnpm audit --prod - -set +e -pnpm audit -set -e - -pnpm run build - -set +ex - -# Publish -echo -echo "Run 'npm publish --dry-run' to test publishing" -echo -echo "If everything looks okay, use 'npm publish --access public'" -echo -echo "Remember to create a tag" -echo "Remember to increase the version number" -echo