build: switch to npm

This commit is contained in:
Enrico Sacchetti 2024-01-09 11:25:31 -05:00
commit 23d4bdec4e
8 changed files with 6993 additions and 4168 deletions

View file

@ -10,15 +10,15 @@ Before submitting a pull request (PR), consider [filing an issue](https://github
- [Component Format](#component-format)
- [Editing a component](#editing-a-component)
- [Creating a component](#creating-a-component)
- [Run `yarn build:docs`](#run-yarn-builddocs)
- [Run `npm run build:docs`](#run-npm-run-builddocs)
- [Submit a Pull Request](#submit-a-pull-request)
- [Sync Your Fork](#sync-your-fork)
- [Submit a PR](#submit-a-pr)
## Prerequisites
- [Node.js](https://nodejs.org/en/download/package-manager/) (version >=12)
- [Yarn](https://classic.yarnpkg.com/en/docs/install)
- [Node.js](https://nodejs.org/en/download/package-manager/) (version >=18)
- [npm](https://docs.npmjs.com/cli) (bundled with Node.js)
## Project set-up
@ -43,7 +43,7 @@ Install the project dependencies:
```sh
# carbon-components-svelte/
yarn install
npm install
```
## Documentation set-up
@ -54,7 +54,7 @@ First, create a symbolic link at the root of the project folder:
```sh
# carbon-components-svelte/
yarn link
npm link
```
Go into the `docs` folder:
@ -66,8 +66,8 @@ cd docs
Link `"carbon-components-svelte"`:
```sh
yarn link "carbon-components-svelte"
yarn install
npm link "carbon-components-svelte"
npm install
```
If linked correctly, any change to a component in the `src` folder should be reflected in the `docs` site.
@ -87,7 +87,7 @@ Preview changes to components from the `src` folder in the documentation website
In the `docs` folder, run:
```sh
yarn dev
npm run dev
```
The site should be served at `http://localhost:3000/` (or the next available port).
@ -134,13 +134,13 @@ export {
} from "./ComposedModal";
```
### Run `yarn build:docs`
### Run `npm run build:docs`
Run the following command to re-generate TypeScript definitions and documentation.
```sh
# carbon-components-svelte/
yarn build:docs
npm run build:docs
```
## Submit a Pull Request
@ -171,11 +171,11 @@ The workflow is automatically triggered when pushing a tag that begins with `v`
However, maintainers must perform a few things in preparation for a release.
Locally, while on `master` and the branch is clean, run `yarn release`. This command will:
Locally, while on `master` and the branch is clean, run `npm run release`. This command will:
- Bump the semantic version in `package.json`
- Generate notes in `CHANGELOG.md`
- Run `yarn build:docs` to update the generated documentation
- Run `npm run build:docs` to update the generated documentation
This command will not create a commit nor tag. Afterwards, perform the following manually: