Skip to content
Draft
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
3 changes: 2 additions & 1 deletion .npmrc
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
min-release-age=7
min-release-age=7
public-hoist-pattern[]=run-node
50 changes: 25 additions & 25 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@ developers to quickly build beautiful and consistent interfaces for our users.
### Prerequisites

- `node@24`
- `npm@11`
- `pnpm@10`

To install Atlantis locally for development:

```sh
git clone git@github.com:GetJobber/atlantis.git
cd atlantis
npm install
pnpm install
```

To start local development for Atlantis:

```sh
npm start
pnpm start
```

This starts the web Storybook, the mobile Storybook, and the docs site together.
Expand All @@ -50,14 +50,14 @@ will automatically take care of managing the versions for you.

When working on some packages (for example `design`) locally, you'll need to run

```
npm run bootstrap
```sh
pnpm run bootstrap
```

and then

```
npm start
```sh
pnpm start
```

to view and test your changes.
Expand Down Expand Up @@ -107,15 +107,15 @@ started.
You should name your component in `PascalCase`.

```sh
npm run generate
pnpm run generate
```

You will be able to select the platform you want to create the component.

#### Example

```sh
❯❯❯ npm run generate
❯❯❯ pnpm run generate

> atlantis@0.0.1 generate /path/to/atlantis
> plop
Expand All @@ -142,28 +142,28 @@ You will be able to select the platform you want to create the component.
To run tests:

```sh
npm test
pnpm test
```

### Linting

To ensure your code passes our linters run:

```sh
npm run lint
pnpm run lint
```

You can also auto fix many linting errors by running:

```
npm run lint:fix
```sh
pnpm run lint:fix
```

You can run the linters separately with:

```sh
npm run lint:css
npm run lint:ts
pnpm run lint:css
pnpm run lint:js
```

If you want to troubleshoot linting errors in CI, try running locally first to
Expand All @@ -186,10 +186,10 @@ The primary packages in here are:

When installing dependencies be sure to install them relative to the appropriate
sub package. For example if you want to use package `foo` in the components
package, you would run `npm install foo -w @jobber/components`.
package, you would run `pnpm --filter @jobber/components add foo`.

For more information on how the packages are bootstrapped, check out
[NPM workspaces](https://docs.npmjs.com/cli/v9/using-npm/workspaces).
[pnpm workspaces](https://pnpm.io/workspaces).

## Contributing

Expand All @@ -206,7 +206,7 @@ publish whenever a pull request is merged.
Follow [semver](https://semver.org) when choosing versions.

```sh
npm run release-the-kraken
pnpm run release-the-kraken
```

### Publishing a failed release to NPM
Expand All @@ -217,15 +217,15 @@ publish to NPM. If this happens and you're one of the Atlantis NPM
collaborators, run the code below to send unpublished versions to NPM.

```sh
npm run release:unpublished-package
pnpm run release:unpublished-package
```

## Pre-release

### Releasing manually (Team Atlantis Only)

```sh
npm run publish:prerelease
pnpm run publish:prerelease
```

### Releasing with dependency changes
Expand All @@ -236,7 +236,7 @@ that as a releasable "change". The script below should allow you to create a
prerelease for package changes.

```sh
npm run publish:prerelease:force @jobber/components
pnpm run publish:prerelease:force @jobber/components
```

_NOTE: You can replace `@jobber/components` with the package you want to
Expand All @@ -253,7 +253,7 @@ It is possible to generate Pre-releases through GitHub Actions.
`Publish Pre-release (Recommended)` option
5. If you only have dependency changes run the `Force Publish <package>` to get
those changes published. This is only needed if the only file modified is the
`package.json` or `package-lock.json`
`package.json` or `pnpm-lock.yaml`
6. When the Action is finished your PR will have a comment with the new release
versions

Expand All @@ -264,11 +264,11 @@ forced pre-release._
## Local testing

If you're not sharing your changes with your peers yet and want a quicker way to
check your changes, you can run `npm run pack {{scope}}` from the root folder
against one of the workspaces.
check your changes, you can run `pnpm run pack -- {{scope}}` from the root
folder against one of the workspaces.

```sh
npm run pack @jobber/components
pnpm run pack -- @jobber/components
```

That will create a `jobber-components-{{version}}.tgz` file on the root. You can
Expand Down
3 changes: 2 additions & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"version": "independent",
"npmClient": "pnpm",
"packages": [
"packages/*"
],
Expand All @@ -17,7 +18,7 @@
"**/*.stories.tsx",
"lerna.json",
"package.json",
"package-lock.json",
"pnpm-lock.yaml",
"CHANGELOG.md"
]
}
Expand Down
Loading