Skip to content

Commit

Permalink
fix(eslint): Resolve issue with missing dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
sullivanpj committed Jun 4, 2024
1 parent b42c179 commit b0f4345
Show file tree
Hide file tree
Showing 13 changed files with 179 additions and 31 deletions.
7 changes: 5 additions & 2 deletions packages/build-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Build Tools

This package contains the build tools used by the Storm Software monorepo. It is a collection of tools and utilities that are used to build, test, and deploy the various applications and libraries that are part of the Storm Software monorepo.
This package contains the build tools used by the Storm Software monorepo. It is
a collection of tools and utilities that are used to build, test, and deploy the
various applications and libraries that are part of the Storm Software monorepo.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -76,7 +78,8 @@ Run `nx build build-tools` to build-tools the library.

## Running unit tests

Run `nx test build-tools` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test build-tools` to execute the unit tests via
[Jest](https://jestjs.io).

<!-- START footer -->
<!-- prettier-ignore-start -->
Expand Down
12 changes: 8 additions & 4 deletions packages/cloudflare-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Cloudflare Tools

A package containing tools for managing a Storm workspace. It includes various [Nx](https://nx.dev) generators and executors for common development tasks.
A package containing tools for managing a Storm workspace. It includes various
[Nx](https://nx.dev) generators and executors for common development tasks.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -74,7 +75,8 @@ yarn add -D @storm-software/cloudflare-tools

## Executors

The following executors are available in this package to invoke common tasks for the workspace's projects:
The following executors are available in this package to invoke common tasks for
the workspace's projects:

<!-- START executors -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -182,7 +184,8 @@ The following executor options are available:

## Generators

The following generators are available with this package to assist in workspace management:
The following generators are available with this package to assist in workspace
management:

<!-- START generators -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -248,7 +251,8 @@ Run `nx build cloudflare-tools` to build the library.

## Running unit tests

Run `nx test cloudflare-tools` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test cloudflare-tools` to execute the unit tests via
[Jest](https://jestjs.io).

<!-- START footer -->
<!-- prettier-ignore-start -->
Expand Down
17 changes: 12 additions & 5 deletions packages/config-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Configuration Tools

A package containing various utilities to support custom workspace configurations
A package containing various utilities to support custom workspace
configurations

Below is a list of the available configuration values that can be set through environment variables:
Below is a list of the available configuration values that can be set through
environment variables:

| Name | Description | Default |
| ----------------------- | -------------------------------------------------------------------------------------- | --------------------------- |
Expand Down Expand Up @@ -94,19 +96,24 @@ yarn add -D @storm-software/config-tools

## Reduced Package Size

This project uses [tsup](https://tsup.egoist.dev/) to package the source code due to its ability to remove unused code and ship smaller javascript files thanks to code splitting. This helps to greatly reduce the size of the package and to make it easier to use in other projects.
This project uses [tsup](https://tsup.egoist.dev/) to package the source code
due to its ability to remove unused code and ship smaller javascript files
thanks to code splitting. This helps to greatly reduce the size of the package
and to make it easier to use in other projects.

## Development

This project is built using [Nx](https://nx.dev). As a result, many of the usual commands are available to assist in development.
This project is built using [Nx](https://nx.dev). As a result, many of the usual
commands are available to assist in development.

### Building

Run `nx build config-tools` to build the library.

### Running unit tests

Run `nx test config-tools` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test config-tools` to execute the unit tests via
[Jest](https://jestjs.io).

### Linting

Expand Down
14 changes: 10 additions & 4 deletions packages/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Configuration Package

A package containing the definition and Zod validation schema for the custom workspace configuration used by the Storm Software organization.
A package containing the definition and Zod validation schema for the custom
workspace configuration used by the Storm Software organization.

Below is a list of the available configuration values that can be set through environment variables:
Below is a list of the available configuration values that can be set through
environment variables:

| Name | Description | Default |
| ----------------------- | -------------------------------------------------------------------------------------- | --------------------------- |
Expand Down Expand Up @@ -93,11 +95,15 @@ yarn add -D @storm-software/config

## Reduced Package Size

This project uses [tsup](https://tsup.egoist.dev/) to package the source code due to its ability to remove unused code and ship smaller javascript files thanks to code splitting. This helps to greatly reduce the size of the package and to make it easier to use in other projects.
This project uses [tsup](https://tsup.egoist.dev/) to package the source code
due to its ability to remove unused code and ship smaller javascript files
thanks to code splitting. This helps to greatly reduce the size of the package
and to make it easier to use in other projects.

## Development

This project is built using [Nx](https://nx.dev). As a result, many of the usual commands are available to assist in development.
This project is built using [Nx](https://nx.dev). As a result, many of the usual
commands are available to assist in development.

### Building

Expand Down
6 changes: 4 additions & 2 deletions packages/create-storm-workspace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

This package can be used to generate a Storm workspace.

It is essentially a wrapper around the [Nx CLI](https://nx.dev) that adds some additional functionality.
It is essentially a wrapper around the [Nx CLI](https://nx.dev) that adds some
additional functionality.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -78,7 +79,8 @@ Run `nx build create-storm-workspace` to build the library.

## Running unit tests

Run `nx test create-storm-workspace` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test create-storm-workspace` to execute the unit tests via
[Jest](https://jestjs.io).

<!-- START footer -->
<!-- prettier-ignore-start -->
Expand Down
1 change: 1 addition & 0 deletions packages/eslint-plugin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
"@nx/eslint-plugin": "^19.1.0",
"@nx/js": "^19.1.0",
"@nx/workspace": "^19.1.0",
"@typescript-eslint/eslint-plugin": "^7.12.0",
"@typescript-eslint/type-utils": "^7.3.0",
"@typescript-eslint/utils": "^7.3.0",
"chalk": "^4.1.0",
Expand Down
2 changes: 1 addition & 1 deletion packages/eslint/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
],
"dependencies": {
"@graphql-eslint/eslint-plugin": "^3.20.1",
"@typescript-eslint/eslint-plugin": "^7.0.0",
"@typescript-eslint/eslint-plugin": "^7.11.0",
"@typescript-eslint/parser": "^7.0.0",
"eslint": "9.4.0",
"eslint-config-prettier": "^9.1.0",
Expand Down
4 changes: 3 additions & 1 deletion packages/git-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Git Tools

This package contains various [Git](https://git-scm.com/) management tools combined to make the process of management a workspace easier. Included within is an easy to use CLI tool that combines the following functionality:
This package contains various [Git](https://git-scm.com/) management tools
combined to make the process of management a workspace easier. Included within
is an easy to use CLI tool that combines the following functionality:

- [Commitlint](https://commitlint.js.org/#/)
- [Commitizen](https://commitizen-tools.github.io/commitizen/)
Expand Down
7 changes: 5 additions & 2 deletions packages/linting-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Linting Tools

This package combines various linting tools used to validate syntax, enforce design standards, and format code in a Storm workspace. The following packages are included and combined into an easy to use CLI tool:
This package combines various linting tools used to validate syntax, enforce
design standards, and format code in a Storm workspace. The following packages
are included and combined into an easy to use CLI tool:

- [ESLint](https://eslint.org/)
- [Prettier](https://prettier.io/)
Expand Down Expand Up @@ -84,7 +86,8 @@ Run `nx build linting-tools` to build the library.

## Running unit tests

Run `nx test linting-tools` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test linting-tools` to execute the unit tests via
[Jest](https://jestjs.io).

<!-- START footer -->
<!-- prettier-ignore-start -->
Expand Down
8 changes: 6 additions & 2 deletions packages/markdownlint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Markdownlint Rules

An opinionated collection of markdownlint rules used by Storm Software. This package includes the rules used by GitHub in the [markdownlint-github](https://github.com/github/markdownlint-github) package, as well as additional rules that are specific to Storm Software.
An opinionated collection of markdownlint rules used by Storm Software. This
package includes the rules used by GitHub in the
[markdownlint-github](https://github.com/github/markdownlint-github) package, as
well as additional rules that are specific to Storm Software.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -76,7 +79,8 @@ Run `nx build markdownlint` to build the library.

## Running unit tests

Run `nx test markdownlint` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test markdownlint` to execute the unit tests via
[Jest](https://jestjs.io).

<!-- START footer -->
<!-- prettier-ignore-start -->
Expand Down
7 changes: 5 additions & 2 deletions packages/testing-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Testing Tools

This package contains various testing tools used by Storm workspaces to drive unit and e2e testing. The following packages are included and combined into an easy to use CLI tool:
This package contains various testing tools used by Storm workspaces to drive
unit and e2e testing. The following packages are included and combined into an
easy to use CLI tool:

- [Jest](https://jestjs.io/)
- [Vitest](https://vitest.dev/)
Expand Down Expand Up @@ -80,7 +82,8 @@ Run `nx build testing-tools` to build the library.

## Running unit tests

Run `nx test testing-tools` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test testing-tools` to execute the unit tests via
[Jest](https://jestjs.io).

<!-- START footer -->
<!-- prettier-ignore-start -->
Expand Down
12 changes: 8 additions & 4 deletions packages/workspace-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages

# Storm Workspace Tools

A package containing tools for managing a Storm workspace. It includes various [Nx](https://nx.dev) generators and executors for common development tasks.
A package containing tools for managing a Storm workspace. It includes various
[Nx](https://nx.dev) generators and executors for common development tasks.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
Expand Down Expand Up @@ -74,7 +75,8 @@ yarn add -D @storm-software/workspace-tools

## Executors

The following executors are available in this package to invoke common tasks for the workspace's projects:
The following executors are available in this package to invoke common tasks for
the workspace's projects:

<!-- START executors -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -366,7 +368,8 @@ The following executor options are available:

## Generators

The following generators are available with this package to assist in workspace management:
The following generators are available with this package to assist in workspace
management:

<!-- START generators -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -592,7 +595,8 @@ Run `nx build workspace-tools` to build the library.

## Running unit tests

Run `nx test workspace-tools` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test workspace-tools` to execute the unit tests via
[Jest](https://jestjs.io).

<!-- START footer -->
<!-- prettier-ignore-start -->
Expand Down
Loading

0 comments on commit b0f4345

Please sign in to comment.