@storm-software/workspace-tools 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +88 -0
- package/README.md +2 -2
- package/config/nx.json +22 -53
- package/package.json +1 -1
- package/src/generators/init/init.js +1 -16
- package/src/generators/init/init.js.map +1 -1
- package/src/generators/preset/files/.all-contributorsrc.template +18 -4
- package/src/generators/preset/files/.env.template +11 -32
- package/src/generators/preset/files/.gitattributes +9 -0
- package/src/generators/preset/files/.github/CONTRIBUTING.md.template +1 -1
- package/src/generators/preset/files/.github/ISSUE_TEMPLATE/bug-report.yml.template +38 -7
- package/src/generators/preset/files/.github/ISSUE_TEMPLATE/documentation.yml.template +12 -12
- package/src/generators/preset/files/.github/ISSUE_TEMPLATE/feature-request.yml.template +4 -7
- package/src/generators/preset/files/.github/PULL_REQUEST_TEMPLATE.md.template +1 -1
- package/src/generators/preset/files/.github/actions/node/action.yaml +11 -12
- package/src/generators/preset/files/.github/codecov.yml +1 -1
- package/src/generators/preset/files/.github/renovate.json.template +3 -7
- package/src/generators/preset/files/.github/workflows/ci.yml.template +91 -0
- package/src/generators/preset/files/.github/workflows/codeql.yml +4 -1
- package/src/generators/preset/files/.github/workflows/git-guardian.yml +5 -3
- package/src/generators/preset/files/.github/workflows/labels.yml +6 -5
- package/src/generators/preset/files/.github/workflows/lock.yml +1 -4
- package/src/generators/preset/files/.github/workflows/nextjs-bundle-analysis.yml +12 -28
- package/src/generators/preset/files/.husky/post-checkout +1 -2
- package/src/generators/preset/files/.husky/post-commit +4 -0
- package/src/generators/preset/files/.husky/post-merge +1 -2
- package/src/generators/preset/files/.husky/pre-commit +1 -2
- package/src/generators/preset/files/.husky/pre-push +3 -2
- package/src/generators/preset/files/.markdownlint.json +4 -1
- package/src/generators/preset/files/.verdaccio/config.yml.template +1 -1
- package/src/generators/preset/files/.vscode/extensions.json +1 -1
- package/src/generators/preset/files/.vscode/launch.json +3 -3
- package/src/generators/preset/files/README.md.template +31 -30
- package/src/generators/preset/files/eslint.config.js +58 -0
- package/src/generators/preset/files/nx.json +98 -0
- package/src/generators/preset/files/pnpm-workspace.yaml +2 -0
- package/src/generators/preset/files/socket.yaml +20 -0
- package/src/generators/preset/files/tsconfig.base.json.template +1 -1
- package/src/generators/preset/generator.js +140 -65
- package/src/generators/preset/generator.js.map +1 -1
- package/src/generators/preset/schema.d.ts +8 -0
- package/src/generators/preset/schema.json +86 -2
- package/src/utils/versions.d.ts +4 -1
- package/src/generators/preset/files/.alexignore +0 -4
- package/src/generators/preset/files/.alexrc +0 -39
- package/src/generators/preset/files/.eslintrc.json +0 -123
- package/src/generators/preset/files/.github/workflows/ci.yml +0 -131
- package/src/generators/preset/files/.github/workflows/documentation.yml.template +0 -85
- package/src/generators/preset/files/.husky/commit-msg +0 -4
- package/src/generators/preset/files/commitlint.config.d.ts +0 -2
- package/src/generators/preset/files/commitlint.config.js +0 -3
- package/src/generators/preset/files/commitlint.config.js.map +0 -1
- package/src/generators/preset/files/src/index.ts.template +0 -1
- /package/src/generators/preset/files/{.log4brains.yml → .log4brains.yml.template} +0 -0
|
@@ -26,4 +26,4 @@ comment:
|
|
|
26
26
|
require_changes: false # if true: only post the comment if coverage changes
|
|
27
27
|
require_base: false # [yes :: must have a base report to post]
|
|
28
28
|
require_head: true # [yes :: must have a head report to post]
|
|
29
|
-
branches: ["main"
|
|
29
|
+
branches: ["main"]
|
|
@@ -22,14 +22,14 @@
|
|
|
22
22
|
},
|
|
23
23
|
"packageRules": [
|
|
24
24
|
{
|
|
25
|
-
"matchPackagePatterns": ["^@<%=
|
|
25
|
+
"matchPackagePatterns": ["^@<%= namespace %>/"],
|
|
26
26
|
"enabled": true
|
|
27
27
|
},
|
|
28
28
|
{
|
|
29
29
|
"matchPackageNames": ["@nx"],
|
|
30
30
|
"postUpgradeTasks": {
|
|
31
31
|
"commands": [
|
|
32
|
-
"npx nx migrate latest --run-migrations --create-commits --commit-message='chore(<%= name %>): update @nx dependencies'"
|
|
32
|
+
"npx nx migrate latest --run-migrations --create-commits --commit-message='chore(<%= name %>): update @nx dependencies [skip ci]'"
|
|
33
33
|
]
|
|
34
34
|
}
|
|
35
35
|
},
|
|
@@ -47,9 +47,5 @@
|
|
|
47
47
|
"depTypeList": ["dependencies"],
|
|
48
48
|
"updateTypes": ["patch", "pin"]
|
|
49
49
|
}
|
|
50
|
-
]
|
|
51
|
-
"vulnerabilityAlerts": {
|
|
52
|
-
"enabled": true
|
|
53
|
-
},
|
|
54
|
-
"osvVulnerabilityAlerts": true
|
|
50
|
+
]
|
|
55
51
|
}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
name: "CI/CD"
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
workflow_dispatch:
|
|
5
|
+
inputs:
|
|
6
|
+
tag:
|
|
7
|
+
description: override release tag
|
|
8
|
+
required: false
|
|
9
|
+
push:
|
|
10
|
+
branches:
|
|
11
|
+
- "main"
|
|
12
|
+
- "next"
|
|
13
|
+
- "alpha"
|
|
14
|
+
- "beta"
|
|
15
|
+
|
|
16
|
+
env:
|
|
17
|
+
CI: true
|
|
18
|
+
NX_DAEMON: false
|
|
19
|
+
NX_VERBOSE_LOGGING: true
|
|
20
|
+
STORM_REPO_WORKER: stormie-bot
|
|
21
|
+
STORM_REPO_URL: ${{ github.repositoryUrl }}
|
|
22
|
+
STORM_REPO_ROOT: ${{ github.workspace }}
|
|
23
|
+
NX_BASE: ${{ github.base_ref }}
|
|
24
|
+
NX_HEAD: ${{ github.head_ref }}
|
|
25
|
+
GITHUB_ACTOR: ${{ github.actor }}
|
|
26
|
+
GITHUB_TOKEN: ${{ github.token }}
|
|
27
|
+
NPM_TOKEN: ${{ secrets.STORMIE_NPM_TOKEN }}
|
|
28
|
+
NPM_CONFIG_REGISTRY: https://registry.npmjs.org/
|
|
29
|
+
|
|
30
|
+
jobs:
|
|
31
|
+
build-and-release:
|
|
32
|
+
if: github.repository == '<%= organization %>/<%= name %>' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/next' || github.ref == 'refs/heads/alpha' || github.ref == 'refs/heads/beta')
|
|
33
|
+
name: "Build & Release"
|
|
34
|
+
runs-on: ubuntu-latest
|
|
35
|
+
steps:
|
|
36
|
+
- uses: actions/checkout@v4
|
|
37
|
+
with:
|
|
38
|
+
fetch-depth: 0
|
|
39
|
+
token: ${{ secrets.STORMIE_GITHUB_TOKEN }}
|
|
40
|
+
|
|
41
|
+
- name: Setup workspace
|
|
42
|
+
uses: ./.github/actions/setup-workspace
|
|
43
|
+
|
|
44
|
+
- name: configure git
|
|
45
|
+
run: |
|
|
46
|
+
git config user.name "${{ env.STORM_REPO_WORKER }}"
|
|
47
|
+
git config user.email "${{ env.STORM_REPO_WORKER }}@users.noreply.github.com"
|
|
48
|
+
|
|
49
|
+
- name: Get appropriate base and head commits for `nx affected` commands
|
|
50
|
+
uses: nrwl/nx-set-shas@v4
|
|
51
|
+
with:
|
|
52
|
+
main-branch-name: "main"
|
|
53
|
+
|
|
54
|
+
- name: Set appropriate base and head commits for `nx affected` commands
|
|
55
|
+
run: |
|
|
56
|
+
echo "BASE: ${{ env.NX_BASE }}"
|
|
57
|
+
echo "HEAD: ${{ env.NX_HEAD }}"
|
|
58
|
+
|
|
59
|
+
- name: Build repository packages
|
|
60
|
+
run: pnpm nx run-many -t build --parallel=5
|
|
61
|
+
|
|
62
|
+
- name: Run Linters
|
|
63
|
+
run: pnpm lint
|
|
64
|
+
|
|
65
|
+
- name: Run Formatters
|
|
66
|
+
run: pnpm nx format
|
|
67
|
+
|
|
68
|
+
- name: Build repository packages
|
|
69
|
+
run: pnpm nx affected -t build --parallel=5 --base=${{ env.NX_BASE }} --head=${{ env.NX_HEAD }}
|
|
70
|
+
|
|
71
|
+
#- name: Run Tests
|
|
72
|
+
# uses: nick-fields/retry@v2.8.3
|
|
73
|
+
# with:
|
|
74
|
+
# command: npx nx affected -t test --parallel=3 --configuration=ci --base=${{ github.event.before }}
|
|
75
|
+
# timeout_minutes: 10
|
|
76
|
+
# max_attempts: 3
|
|
77
|
+
|
|
78
|
+
#- name: Upload coverage to Codecov
|
|
79
|
+
# uses: codecov/codecov-action@v3
|
|
80
|
+
|
|
81
|
+
- name: Release Library Version Updates
|
|
82
|
+
run: pnpm release --base=${{ env.NX_BASE }} --head=${{ env.NX_HEAD }}
|
|
83
|
+
env:
|
|
84
|
+
GITHUB_TOKEN: ${{ env.GITHUB_TOKEN }}
|
|
85
|
+
GH_TOKEN: ${{ env.GITHUB_TOKEN }}
|
|
86
|
+
NPM_TOKEN: ${{ env.NPM_TOKEN }}
|
|
87
|
+
NPM_AUTH_TOKEN: ${{ env.NPM_TOKEN }}
|
|
88
|
+
NODE_AUTH_TOKEN: ${{ env.NPM_TOKEN }}
|
|
89
|
+
STORM_REPO_ROOT: ${{ env.STORM_REPO_ROOT }}
|
|
90
|
+
STORM_REPO_URL: ${{ env.STORM_REPO_URL }}
|
|
91
|
+
TAG: ${{ inputs.tag }}
|
|
@@ -46,7 +46,10 @@ jobs:
|
|
|
46
46
|
|
|
47
47
|
steps:
|
|
48
48
|
- name: Checkout repository
|
|
49
|
-
uses: actions/checkout@
|
|
49
|
+
uses: actions/checkout@v4
|
|
50
|
+
with:
|
|
51
|
+
fetch-depth: 0
|
|
52
|
+
token: ${{ secrets.STORMIE_GITHUB_TOKEN }}
|
|
50
53
|
|
|
51
54
|
# Initializes the CodeQL tools for scanning.
|
|
52
55
|
- name: Initialize CodeQL
|
|
@@ -7,10 +7,12 @@ jobs:
|
|
|
7
7
|
name: GitGuardian scan
|
|
8
8
|
runs-on: ubuntu-latest
|
|
9
9
|
steps:
|
|
10
|
-
- name: Checkout
|
|
11
|
-
uses: actions/checkout@
|
|
10
|
+
- name: Checkout repository
|
|
11
|
+
uses: actions/checkout@v4
|
|
12
12
|
with:
|
|
13
|
-
fetch-depth: 0
|
|
13
|
+
fetch-depth: 0
|
|
14
|
+
token: ${{ secrets.STORMIE_GITHUB_TOKEN }}
|
|
15
|
+
|
|
14
16
|
- name: GitGuardian scan
|
|
15
17
|
uses: GitGuardian/ggshield-action@master
|
|
16
18
|
env:
|
|
@@ -13,17 +13,18 @@ env:
|
|
|
13
13
|
NX_DAEMON: false
|
|
14
14
|
NX_VERBOSE_LOGGING: true
|
|
15
15
|
SKIP_ENV_VALIDATION: true
|
|
16
|
-
GITHUB_ACTOR: "🤖 Storm Bot"
|
|
17
|
-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
18
|
-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
19
16
|
|
|
20
17
|
jobs:
|
|
21
18
|
labels:
|
|
22
19
|
name: ♻️ Sync labels
|
|
23
20
|
runs-on: ubuntu-latest
|
|
24
21
|
steps:
|
|
25
|
-
- name:
|
|
26
|
-
uses: actions/checkout@
|
|
22
|
+
- name: Checkout repository
|
|
23
|
+
uses: actions/checkout@v4
|
|
24
|
+
with:
|
|
25
|
+
fetch-depth: 0
|
|
26
|
+
token: ${{ secrets.GITHUB_TOKEN }}
|
|
27
|
+
|
|
27
28
|
- name: 🚀 Run Label Syncer
|
|
28
29
|
uses: micnncim/action-label-syncer@v1.3.0
|
|
29
30
|
env:
|
|
@@ -11,9 +11,6 @@ env:
|
|
|
11
11
|
NX_DAEMON: false
|
|
12
12
|
NX_VERBOSE_LOGGING: true
|
|
13
13
|
SKIP_ENV_VALIDATION: true
|
|
14
|
-
GITHUB_ACTOR: "🤖 Storm Bot"
|
|
15
|
-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
16
|
-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
17
14
|
|
|
18
15
|
jobs:
|
|
19
16
|
lock:
|
|
@@ -22,7 +19,7 @@ jobs:
|
|
|
22
19
|
steps:
|
|
23
20
|
- uses: dessant/lock-threads@v4
|
|
24
21
|
with:
|
|
25
|
-
github-token: ${{
|
|
22
|
+
github-token: ${{ secrets.GITHUB_TOKEN }}
|
|
26
23
|
issue-inactive-days: "30"
|
|
27
24
|
issue-lock-reason: ""
|
|
28
25
|
pr-inactive-days: "1"
|
|
@@ -19,30 +19,19 @@ env:
|
|
|
19
19
|
NX_DAEMON: false
|
|
20
20
|
NX_VERBOSE_LOGGING: true
|
|
21
21
|
SKIP_ENV_VALIDATION: true
|
|
22
|
-
|
|
23
|
-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
24
|
-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
22
|
+
ANALYZE: true
|
|
25
23
|
|
|
26
24
|
jobs:
|
|
27
25
|
analyze:
|
|
28
26
|
runs-on: ubuntu-latest
|
|
29
27
|
steps:
|
|
30
|
-
- uses: actions/checkout@
|
|
31
|
-
|
|
32
|
-
- name: Setup pnpm
|
|
33
|
-
uses: pnpm/action-setup@v2.2.4
|
|
34
|
-
with:
|
|
35
|
-
version: 8
|
|
36
|
-
|
|
37
|
-
- uses: actions/setup-node@v3
|
|
28
|
+
- uses: actions/checkout@v4
|
|
38
29
|
with:
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
cache: pnpm
|
|
42
|
-
cache-dependency-path: pnpm-lock.yaml
|
|
30
|
+
fetch-depth: 0
|
|
31
|
+
token: ${{ secrets.STORMIE_GITHUB_TOKEN }}
|
|
43
32
|
|
|
44
|
-
- name:
|
|
45
|
-
|
|
33
|
+
- name: Setup workspace
|
|
34
|
+
uses: ./.github/actions/setup-workspace
|
|
46
35
|
|
|
47
36
|
- name: Restore next build
|
|
48
37
|
uses: actions/cache@v3
|
|
@@ -50,33 +39,28 @@ jobs:
|
|
|
50
39
|
env:
|
|
51
40
|
cache-name: cache-next-build
|
|
52
41
|
with:
|
|
53
|
-
path: dist/apps/web/
|
|
42
|
+
path: dist/apps/web/app/.next/cache
|
|
54
43
|
# change this if you prefer a more strict cache
|
|
55
44
|
key: ${{ runner.os }}-build-${{ env.cache-name }}
|
|
56
45
|
|
|
57
|
-
- name: Set appropriate base and head commits for `nx affected` commands
|
|
58
|
-
run: |
|
|
59
|
-
echo "BASE: ${{ env.NX_BASE }}"
|
|
60
|
-
echo "HEAD: ${{ env.NX_HEAD }}"
|
|
61
|
-
|
|
62
|
-
- name: Prepare for build
|
|
63
|
-
run: pnpm build --base=${{ env.NX_BASE }} --head=${{ env.NX_HEAD }}
|
|
64
|
-
|
|
65
46
|
- name: Build next.js app
|
|
47
|
+
run: pnpm nx run web-app:build
|
|
66
48
|
env:
|
|
67
49
|
SKIP_BUILD_PRODUCT_REDIRECTS: 1
|
|
68
|
-
|
|
50
|
+
ANALYZE: true
|
|
69
51
|
|
|
70
52
|
# Here's the first place where next-bundle-analysis' own script is used
|
|
71
53
|
# This step pulls the raw bundle stats for the current bundle
|
|
72
54
|
- name: Analyze bundle
|
|
73
55
|
run: pnpm -p nextjs-bundle-analysis report
|
|
56
|
+
env:
|
|
57
|
+
ANALYZE: true
|
|
74
58
|
|
|
75
59
|
- name: Upload bundle
|
|
76
60
|
uses: actions/upload-artifact@v3
|
|
77
61
|
with:
|
|
78
62
|
name: bundle
|
|
79
|
-
path: dist/apps/web/
|
|
63
|
+
path: dist/apps/web/app/.next/analyze/__bundle_analysis.json
|
|
80
64
|
|
|
81
65
|
#- name: Download base branch bundle stats
|
|
82
66
|
# uses: dawidd6/action-download-artifact@v2
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
#!/bin/sh
|
|
2
2
|
. "$(dirname "$0")/_/husky.sh"
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
node @storm-software/workspace-tools/scripts/package-version-warning.js $changedFiles
|
|
4
|
+
echo $HUSKY_GIT_STDIN | @storm-software/git-tools/hooks/post-checkout $HUSKY_GIT_PARAMS
|
|
6
5
|
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
#!/bin/sh
|
|
2
2
|
. "$(dirname "$0")/_/husky.sh"
|
|
3
3
|
|
|
4
|
-
|
|
5
|
-
node @storm-software/workspace-tools/scripts/package-version-warning.js $changedFiles
|
|
4
|
+
echo $HUSKY_GIT_STDIN | @storm-software/git-tools/hooks/post-merge $HUSKY_GIT_PARAMS
|
|
6
5
|
|
|
@@ -1,3 +1,4 @@
|
|
|
1
1
|
#!/bin/sh
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
. "$(dirname "$0")/_/husky.sh"
|
|
3
|
+
|
|
4
|
+
echo $HUSKY_GIT_STDIN | @storm-software/git-tools/hooks/pre-push $HUSKY_GIT_PARAMS
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"type": "extensionHost",
|
|
7
7
|
"request": "launch",
|
|
8
8
|
"args": [
|
|
9
|
-
"--extensionDevelopmentPath=${workspaceFolder}/node_modules/@
|
|
9
|
+
"--extensionDevelopmentPath=${workspaceFolder}/node_modules/@power-plant/language"
|
|
10
10
|
]
|
|
11
11
|
},
|
|
12
12
|
{
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
"type": "extensionHost",
|
|
15
15
|
"request": "launch",
|
|
16
16
|
"args": [
|
|
17
|
-
"--extensionDevelopmentPath=${workspaceFolder}/node_modules
|
|
17
|
+
"--extensionDevelopmentPath=${workspaceFolder}/node_modules/power-plant"
|
|
18
18
|
]
|
|
19
19
|
},
|
|
20
20
|
{
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"skipFiles": ["<node_internals>/**"],
|
|
33
33
|
"sourceMaps": true,
|
|
34
34
|
"outFiles": [
|
|
35
|
-
"${workspaceFolder}/node_modules/@
|
|
35
|
+
"${workspaceFolder}/node_modules/@power-plant/language/**/*.js"
|
|
36
36
|
]
|
|
37
37
|
}
|
|
38
38
|
]
|
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" altText="
|
|
1
|
+
<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" altText="storm-ops" /></div>
|
|
2
2
|
|
|
3
3
|
<div align="center">
|
|
4
|
-
<a href="https://
|
|
4
|
+
<a href="https://stormsoftware.org" target="_blank">Website</a> | <a href="https://stormsoftware.org/contact" target="_blank">Contact</a> | <a href="https://github.com/storm-software/storm-ops" target="_blank">Repository</a> | <a href="https://storm-software.github.io/storm-ops/" target="_blank">Documentation</a> | <a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a> | <a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=Feature Request%3A+">Request a Feature</a> | <a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=documentation&template=documentation.yml&title=Documentation Request%3A+">Request Documentation</a> | <a href="https://github.com/storm-software/storm-ops/discussions">Ask a Question</a>
|
|
5
5
|
</div>
|
|
6
6
|
|
|
7
7
|
<br />
|
|
8
|
-
Storm Software's <b>⚡<%= name %></b> monorepo contains
|
|
9
|
-
<br />
|
|
10
|
-
|
|
8
|
+
Storm Software's <b>⚡<%= name %></b> monorepo contains various configurations and tools used to manage the Storm Software repositories.
|
|
9
|
+
<br /><br />
|
|
10
|
+
Storm-Ops is built using <a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.
|
|
11
11
|
|
|
12
|
-
<h3 align="center">💻 Visit <a href="https://
|
|
12
|
+
<h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
|
|
13
13
|
|
|
14
|
-
[](https://github.com/storm-software/storm-ops) [](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)   
|
|
15
15
|
|
|
16
|
-
<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ - This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across
|
|
16
|
+
<h3 align="center" bold="true">⚠️ <b>Attention</b> ⚠️ - This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.</h3><br />
|
|
17
17
|
|
|
18
18
|
<!--#if GitHubActions-->
|
|
19
19
|
|
|
20
|
-
[](https://github.com/storm-software/storm-ops/actions)
|
|
21
21
|
|
|
22
22
|
<!--#endif-->
|
|
23
23
|
|
|
@@ -80,9 +80,9 @@ The following are some of the features/publishable code that are included in thi
|
|
|
80
80
|
|
|
81
81
|
# Getting Started
|
|
82
82
|
|
|
83
|
-
Once the code is pulled locally, open a command prompt and run `
|
|
83
|
+
Once the code is pulled locally, open a command prompt and run `pnpm install` in the root repo directory (/storm-ops).
|
|
84
84
|
|
|
85
|
-
More information can be found in the [Open System documentation](https://storm-software.github.io
|
|
85
|
+
More information can be found in the [Open System documentation](https://storm-software.github.io/storm-ops/docs/getting-started/installation).
|
|
86
86
|
|
|
87
87
|
## Build
|
|
88
88
|
|
|
@@ -140,11 +140,11 @@ Run `nx g @storm-software/workspace:lib my-lib` to generate a library.
|
|
|
140
140
|
|
|
141
141
|
> You can also use any of the plugins above to generate libraries as well.
|
|
142
142
|
|
|
143
|
-
Libraries are shareable across libraries and applications. They can be imported from
|
|
143
|
+
Libraries are shareable across libraries and applications. They can be imported from `@storm-ops/my-lib`.
|
|
144
144
|
|
|
145
145
|
## Code Scaffolding
|
|
146
146
|
|
|
147
|
-
Run `nx g @nx/react:component my-component --project
|
|
147
|
+
Run `nx g @nx/react:component my-component --project=storm-ops` to generate a new component.
|
|
148
148
|
<br /><br />
|
|
149
149
|
|
|
150
150
|
# Testing
|
|
@@ -185,11 +185,11 @@ Visit [Nx Cloud](https://nx.app/) to learn more.
|
|
|
185
185
|
|
|
186
186
|
# Roadmap
|
|
187
187
|
|
|
188
|
-
See the [open issues](https://github.com/storm-software
|
|
188
|
+
See the [open issues](https://github.com/storm-software/storm-ops/issues) for a list of proposed features (and known issues).
|
|
189
189
|
|
|
190
|
-
- [Top Feature Requests](https://github.com/storm-software
|
|
191
|
-
- [Top Bugs](https://github.com/storm-software
|
|
192
|
-
- [Newest Bugs](https://github.com/storm-software
|
|
190
|
+
- [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
|
|
191
|
+
- [Top Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
|
|
192
|
+
- [Newest Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
|
|
193
193
|
<br /><br />
|
|
194
194
|
|
|
195
195
|
# Contributing
|
|
@@ -205,20 +205,20 @@ Please try to create bug reports that are:
|
|
|
205
205
|
|
|
206
206
|
Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
|
|
207
207
|
|
|
208
|
-
You can use [markdownlint-cli](https://github.com/storm-software
|
|
208
|
+
You can use [markdownlint-cli](https://github.com/storm-software/storm-ops/markdownlint-cli) to check for common markdown style inconsistency.
|
|
209
209
|
<br /><br />
|
|
210
210
|
|
|
211
211
|
# Support
|
|
212
212
|
|
|
213
213
|
Reach out to the maintainer at one of the following places:
|
|
214
214
|
|
|
215
|
-
- [Contact](https://
|
|
216
|
-
- [GitHub discussions](https://github.com/storm-software
|
|
217
|
-
- <contact@
|
|
215
|
+
- [Contact](https://stormsoftware.org/contact)
|
|
216
|
+
- [GitHub discussions](https://github.com/storm-software/storm-ops/discussions)
|
|
217
|
+
- <contact@stormsoftware.org>
|
|
218
218
|
|
|
219
219
|
# License
|
|
220
220
|
|
|
221
|
-
This project is licensed under the **Apache License 2.0**. Feel free to edit and distribute this template as you like.
|
|
221
|
+
This project is licensed under the **Apache License 2.0**. Feel free to edit and distribute this template as you like. If you have any specific questions, please reach out to the Storm Software development team.
|
|
222
222
|
|
|
223
223
|
See [LICENSE](LICENSE) for more information.
|
|
224
224
|
|
|
@@ -232,17 +232,18 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
|
|
232
232
|
<table>
|
|
233
233
|
<tbody>
|
|
234
234
|
<tr>
|
|
235
|
-
<td align="center"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software
|
|
236
|
-
<td align="center"><a href="https://tylerbenning.com/"><img src="https://avatars.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt="Tyler Benning"/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
|
|
235
|
+
<td align="center" valign="top" width="14.28%"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Tests">⚠️</a></td>
|
|
236
|
+
<td align="center" valign="top" width="14.28%"><a href="https://tylerbenning.com/"><img src="https://avatars.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt="Tyler Benning"/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
|
|
237
|
+
<td align="center" valign="top" width="14.28%"><a href="http://stormsoftware.org"><img src="https://avatars.githubusercontent.com/u/149802440?v=4?s=100" width="100px;" alt="Stormie"/><br /><sub><b>Stormie</b></sub></a><br /><a href="#maintenance-stormie-bot" title="Maintenance">🚧</a></td>
|
|
237
238
|
</tr>
|
|
238
239
|
</tbody>
|
|
239
240
|
<tfoot>
|
|
240
241
|
<tr>
|
|
241
242
|
<td align="center" size="13px" colspan="7">
|
|
242
|
-
<
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
243
|
+
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
|
|
244
|
+
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
|
|
245
|
+
</img>
|
|
246
|
+
</td>
|
|
246
247
|
</tr>
|
|
247
248
|
</tfoot>
|
|
248
249
|
</table>
|
|
@@ -260,11 +261,11 @@ This project follows the [all-contributors](https://github.com/all-contributors/
|
|
|
260
261
|
<img src="https://pub-e71cff0f90204755bc910518d63cacf8.r2.dev/logo-opengraph.gif" width="100%"/>
|
|
261
262
|
</div>
|
|
262
263
|
<div align="center">
|
|
263
|
-
<a href="https://
|
|
264
|
+
<a href="https://stormsoftware.org" target="_blank">Website</a> | <a href="https://stormsoftware.org/contact" target="_blank">Contact</a> | <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a> | <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> | <a href="https://github.com/sullivanpj" target="_blank">GitHub</a> | <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
|
|
264
265
|
</div>
|
|
265
266
|
|
|
266
267
|
<div align="center">
|
|
267
268
|
<p><b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D</p>
|
|
268
269
|
</div>
|
|
269
270
|
|
|
270
|
-
<h2 align="center">💻 Visit <a href="https://
|
|
271
|
+
<h2 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h2><br /><br />
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
const { FlatCompat } = require("@eslint/eslintrc");
|
|
2
|
+
const nxEslintPlugin = require("@nx/eslint-plugin");
|
|
3
|
+
const typescriptConfig = require("@storm-software/linting-tools/eslint/typescript");
|
|
4
|
+
const javascriptConfig = require("@storm-software/linting-tools/eslint/javascript");
|
|
5
|
+
const graphqlConfig = require("@storm-software/linting-tools/eslint/graphql");
|
|
6
|
+
const jestConfig = require("@storm-software/linting-tools/eslint/jest");
|
|
7
|
+
const jsonConfig = require("@storm-software/linting-tools/eslint/json");
|
|
8
|
+
const reactConfig = require("@storm-software/linting-tools/eslint/react");
|
|
9
|
+
const nextConfig = require("@storm-software/linting-tools/eslint/next");
|
|
10
|
+
const js = require("@eslint/js");
|
|
11
|
+
const compat = new FlatCompat({
|
|
12
|
+
baseDirectory: __dirname,
|
|
13
|
+
recommendedConfig: js.configs.recommended
|
|
14
|
+
});
|
|
15
|
+
|
|
16
|
+
module.exports = [
|
|
17
|
+
{ plugins: { "@nx": nxEslintPlugin } },
|
|
18
|
+
...compat.config({ parser: "jsonc-eslint-parser" }).map(config => ({
|
|
19
|
+
...config,
|
|
20
|
+
files: ["**/*.json"],
|
|
21
|
+
rules: {}
|
|
22
|
+
})),
|
|
23
|
+
{
|
|
24
|
+
files: ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"],
|
|
25
|
+
rules: {
|
|
26
|
+
"@nx/enforce-module-boundaries": [
|
|
27
|
+
"error",
|
|
28
|
+
{
|
|
29
|
+
enforceBuildableLibDependency: true,
|
|
30
|
+
allow: [],
|
|
31
|
+
depConstraints: [
|
|
32
|
+
{
|
|
33
|
+
sourceTag: "*",
|
|
34
|
+
onlyDependOnLibsWithTags: ["*"]
|
|
35
|
+
}
|
|
36
|
+
]
|
|
37
|
+
}
|
|
38
|
+
]
|
|
39
|
+
}
|
|
40
|
+
},
|
|
41
|
+
...compat.config({ extends: ["plugin:@nx/typescript"] }).map(config => ({
|
|
42
|
+
...config,
|
|
43
|
+
files: ["**/*.ts", "**/*.tsx"],
|
|
44
|
+
rules: {}
|
|
45
|
+
})),
|
|
46
|
+
...compat.config({ extends: ["plugin:@nx/javascript"] }).map(config => ({
|
|
47
|
+
...config,
|
|
48
|
+
files: ["**/*.js", "**/*.jsx"],
|
|
49
|
+
rules: {}
|
|
50
|
+
})),
|
|
51
|
+
...compat.config(typescriptConfig),
|
|
52
|
+
...compat.config(javascriptConfig),
|
|
53
|
+
...compat.config(graphqlConfig),
|
|
54
|
+
...compat.config(jestConfig),
|
|
55
|
+
...compat.config(jsonConfig),
|
|
56
|
+
...compat.config(reactConfig),
|
|
57
|
+
...compat.config(nextConfig)
|
|
58
|
+
];
|