@ng-zen/cli 19.0.0-alpha.4 → 19.1.0-next.1

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.
Files changed (100) hide show
  1. package/.commitlintrc +3 -0
  2. package/.editorconfig +17 -0
  3. package/.github/dependabot.yml +18 -0
  4. package/.github/workflows/ci.yml +112 -0
  5. package/.github/workflows/deploy.yml +33 -0
  6. package/.github/workflows/release.yml +65 -0
  7. package/.husky/commit-msg +1 -0
  8. package/.husky/pre-commit +1 -0
  9. package/.nanostagedrc +5 -0
  10. package/.prettierignore +3 -0
  11. package/.prettierrc +23 -0
  12. package/.releaserc.json +67 -0
  13. package/.storybook/main.ts +17 -0
  14. package/.storybook/preview.ts +13 -0
  15. package/.storybook/stories/pages/1 Welcome.mdx +9 -0
  16. package/.storybook/stories/pages/2 License.mdx +9 -0
  17. package/.storybook/tsconfig.json +10 -0
  18. package/.storybook/typings.d.ts +4 -0
  19. package/.stylelintrc.json +3 -0
  20. package/CHANGELOG.md +12 -0
  21. package/CODE_OF_CONDUCT.md +30 -0
  22. package/CONTRIBUTING.md +27 -0
  23. package/DEVELOPMENT.md +80 -0
  24. package/README.md +113 -14
  25. package/angular.json +66 -0
  26. package/eslint.config.js +40 -0
  27. package/jest.config.ts +20 -0
  28. package/package.json +108 -14
  29. package/projects/schematic-builder/builders/builders.json +9 -0
  30. package/projects/schematic-builder/builders/index.js +100 -0
  31. package/projects/schematic-builder/builders/schema.json +18 -0
  32. package/projects/schematic-builder/package.json +11 -0
  33. package/{schematics → src/schematics}/collection.json +1 -1
  34. package/{schematics → src/schematics}/components/components-generator.ts +1 -1
  35. package/{schematics → src/schematics}/components/files/avatar/avatar.component.ts +3 -3
  36. package/{schematics → src/schematics}/components/files/avatar/avatar.stories.ts +1 -1
  37. package/{schematics → src/schematics}/components/files/button/button.component.ts +2 -2
  38. package/{schematics → src/schematics}/components/files/checkbox/checkbox.component.ts +1 -1
  39. package/{schematics → src/schematics}/components/files/input/input.component.ts +1 -1
  40. package/src/schematics/components/files/switch/index.ts +1 -0
  41. package/src/schematics/components/files/switch/switch.component.scss +63 -0
  42. package/src/schematics/components/files/switch/switch.component.spec.ts +22 -0
  43. package/src/schematics/components/files/switch/switch.component.ts +105 -0
  44. package/src/schematics/components/files/switch/switch.stories.ts +40 -0
  45. package/src/schematics/components/files/textarea/index.ts +1 -0
  46. package/src/schematics/components/files/textarea/textarea.component.scss +38 -0
  47. package/src/schematics/components/files/textarea/textarea.component.spec.ts +22 -0
  48. package/src/schematics/components/files/textarea/textarea.component.ts +25 -0
  49. package/src/schematics/components/files/textarea/textarea.stories.ts +65 -0
  50. package/{schematics → src/schematics}/components/schema.json +1 -1
  51. package/{schematics → src/schematics}/components/templates/README.md.template +3 -3
  52. package/tsconfig.json +31 -0
  53. package/tsconfig.lib.json +11 -0
  54. package/tsconfig.schematics.json +30 -0
  55. package/tsconfig.spec.json +9 -0
  56. package/schematics/components/components-generator.js +0 -3
  57. package/schematics/components/components-generator.js.map +0 -1
  58. package/schematics/components/index.js +0 -11
  59. package/schematics/components/index.js.map +0 -1
  60. package/schematics/ng-add/index.js +0 -12
  61. package/schematics/ng-add/index.js.map +0 -1
  62. package/schematics/ng-add/ng-zen-generator.js +0 -3
  63. package/schematics/ng-add/ng-zen-generator.js.map +0 -1
  64. package/types/generator-schema-base.interface.js +0 -3
  65. package/types/generator-schema-base.interface.js.map +0 -1
  66. package/types/index.js +0 -5
  67. package/types/index.js.map +0 -1
  68. package/types/schematics-folder.type.js +0 -3
  69. package/types/schematics-folder.type.js.map +0 -1
  70. package/utils/add-path-to-tsconfig.util.js +0 -45
  71. package/utils/add-path-to-tsconfig.util.js.map +0 -1
  72. package/utils/apply-file-template.util.js +0 -23
  73. package/utils/apply-file-template.util.js.map +0 -1
  74. package/utils/index.js +0 -6
  75. package/utils/index.js.map +0 -1
  76. /package/{schematics → src/schematics}/components/files/avatar/avatar.component.scss +0 -0
  77. /package/{schematics → src/schematics}/components/files/avatar/avatar.component.spec.ts +0 -0
  78. /package/{schematics → src/schematics}/components/files/avatar/index.ts +0 -0
  79. /package/{schematics → src/schematics}/components/files/button/button.component.scss +0 -0
  80. /package/{schematics → src/schematics}/components/files/button/button.component.spec.ts +0 -0
  81. /package/{schematics → src/schematics}/components/files/button/button.stories.ts +0 -0
  82. /package/{schematics → src/schematics}/components/files/button/index.ts +0 -0
  83. /package/{schematics → src/schematics}/components/files/checkbox/checkbox.component.scss +0 -0
  84. /package/{schematics → src/schematics}/components/files/checkbox/checkbox.component.spec.ts +0 -0
  85. /package/{schematics → src/schematics}/components/files/checkbox/checkbox.stories.ts +0 -0
  86. /package/{schematics → src/schematics}/components/files/checkbox/index.ts +0 -0
  87. /package/{schematics → src/schematics}/components/files/input/index.ts +0 -0
  88. /package/{schematics → src/schematics}/components/files/input/input.component.scss +0 -0
  89. /package/{schematics → src/schematics}/components/files/input/input.component.spec.ts +0 -0
  90. /package/{schematics → src/schematics}/components/files/input/input.stories.ts +0 -0
  91. /package/{schematics → src/schematics}/components/index.ts +0 -0
  92. /package/{schematics → src/schematics}/ng-add/index.ts +0 -0
  93. /package/{schematics → src/schematics}/ng-add/ng-zen-generator.ts +0 -0
  94. /package/{schematics → src/schematics}/ng-add/schema.json +0 -0
  95. /package/{types → src/types}/generator-schema-base.interface.ts +0 -0
  96. /package/{types → src/types}/index.ts +0 -0
  97. /package/{types → src/types}/schematics-folder.type.ts +0 -0
  98. /package/{utils → src/utils}/add-path-to-tsconfig.util.ts +0 -0
  99. /package/{utils → src/utils}/apply-file-template.util.ts +0 -0
  100. /package/{utils → src/utils}/index.ts +0 -0
package/.commitlintrc ADDED
@@ -0,0 +1,3 @@
1
+ {
2
+ "extends": ["@commitlint/config-conventional"]
3
+ }
package/.editorconfig ADDED
@@ -0,0 +1,17 @@
1
+ # Editor configuration, see https://editorconfig.org
2
+ root = true
3
+
4
+ [*]
5
+ charset = utf-8
6
+ indent_style = space
7
+ indent_size = 2
8
+ insert_final_newline = true
9
+ trim_trailing_whitespace = true
10
+
11
+ [*.ts]
12
+ quote_type = single
13
+ ij_typescript_use_double_quotes = false
14
+
15
+ [*.md]
16
+ max_line_length = off
17
+ trim_trailing_whitespace = false
@@ -0,0 +1,18 @@
1
+ version: 2
2
+ updates:
3
+ - package-ecosystem: "npm"
4
+ directory: "/"
5
+ target-branch: develop
6
+ schedule:
7
+ interval: "weekly"
8
+ day: sunday
9
+ - package-ecosystem: "github-actions"
10
+ target-branch: develop
11
+ directory: "/"
12
+ schedule:
13
+ interval: "weekly"
14
+ day: sunday
15
+
16
+
17
+
18
+
@@ -0,0 +1,112 @@
1
+ name: CI
2
+
3
+ on:
4
+ pull_request:
5
+ branches: [master, develop, next]
6
+
7
+ env:
8
+ NODE_VERSION: 22
9
+ RETENTION_DAYS: 30
10
+
11
+ jobs:
12
+ install:
13
+ runs-on: ubuntu-latest
14
+ outputs:
15
+ cache-key: ${{ steps.cache-key.outputs.cache-key }}
16
+ steps:
17
+ - uses: actions/checkout@v4
18
+ - name: Enable Corepack
19
+ run: corepack enable
20
+ - uses: pnpm/action-setup@v4
21
+ - uses: actions/setup-node@v4
22
+ with:
23
+ node-version: ${{ env.NODE_VERSION }}
24
+ cache: pnpm
25
+ - id: cache-key
26
+ run: |
27
+ CACHE_KEY="${{ runner.os }}-node-${{ env.NODE_VERSION }}-pnpm-cache-$(sha256sum pnpm-lock.yaml | cut -d' ' -f1)"
28
+ echo "cache-key=$CACHE_KEY" >> $GITHUB_OUTPUT
29
+ - uses: actions/cache@v4
30
+ id: pnpm-cache
31
+ with:
32
+ path: |
33
+ node_modules
34
+ ~/.pnpm-store
35
+ key: ${{ steps.cache-key.outputs.cache-key }}
36
+ restore-keys: |
37
+ ${{ runner.os }}-node-${{ env.NODE_VERSION }}-pnpm-cache-
38
+ - run: pnpm install --frozen-lockfile
39
+
40
+ lint:
41
+ needs: install
42
+ runs-on: ubuntu-latest
43
+ steps:
44
+ - uses: actions/checkout@v4
45
+ - name: Enable Corepack
46
+ run: corepack enable
47
+ - uses: pnpm/action-setup@v4
48
+ - uses: actions/setup-node@v4
49
+ with:
50
+ node-version: ${{ env.NODE_VERSION }}
51
+ - uses: actions/cache@v4
52
+ with:
53
+ path: |
54
+ node_modules
55
+ ~/.pnpm-store
56
+ key: ${{ needs.install.outputs.cache-key }}
57
+ - run: pnpm run lint
58
+ - uses: actions/upload-artifact@v4
59
+ if: always()
60
+ with:
61
+ name: lint-report
62
+ path: lint-report/
63
+ retention-days: ${{ env.RETENTION_DAYS }}
64
+ test:
65
+ needs: install
66
+ runs-on: ubuntu-latest
67
+ steps:
68
+ - uses: actions/checkout@v4
69
+ - uses: pnpm/action-setup@v4
70
+ with:
71
+ version: ${{ env.PNPM_VERSION }}
72
+ - uses: actions/setup-node@v4
73
+ with:
74
+ node-version: ${{ env.NODE_VERSION }}
75
+ - uses: actions/cache@v4
76
+ with:
77
+ path: |
78
+ node_modules
79
+ ~/.pnpm-store
80
+ key: ${{ needs.install.outputs.cache-key }}
81
+ - run: pnpm run test
82
+ - uses: actions/upload-artifact@v4
83
+ if: always()
84
+ with:
85
+ name: test-report
86
+ path: test-report/
87
+ retention-days: ${{ env.RETENTION_DAYS }}
88
+
89
+ build:
90
+ needs: [install, lint, test]
91
+ runs-on: ubuntu-latest
92
+ steps:
93
+ - uses: actions/checkout@v4
94
+ - uses: pnpm/action-setup@v4
95
+ with:
96
+ version: ${{ env.PNPM_VERSION }}
97
+ - uses: actions/setup-node@v4
98
+ with:
99
+ node-version: ${{ env.NODE_VERSION }}
100
+ - uses: actions/cache@v4
101
+ with:
102
+ path: |
103
+ node_modules
104
+ ~/.pnpm-store
105
+ key: ${{ needs.install.outputs.cache-key }}
106
+ - run: pnpm run build
107
+ - uses: actions/upload-artifact@v4
108
+ if: always()
109
+ with:
110
+ name: build-report
111
+ path: build-report/
112
+ retention-days: ${{ env.RETENTION_DAYS }}
@@ -0,0 +1,33 @@
1
+ name: Deploy Storybook to github pages
2
+
3
+ on:
4
+ push:
5
+ branches: ["master"]
6
+ workflow_dispatch:
7
+
8
+ env:
9
+ NODE_VERSION: 22
10
+ PNPM_VERSION: 10.0.0
11
+
12
+ permissions:
13
+ contents: read
14
+ pages: write
15
+ id-token: write
16
+
17
+ jobs:
18
+ deploy:
19
+ runs-on: ubuntu-latest
20
+ steps:
21
+ - uses: actions/checkout@v4 # Checkout your repository
22
+ - uses: pnpm/action-setup@v4
23
+ with:
24
+ version: ${{ env.PNPM_VERSION }}
25
+ - uses: actions/setup-node@v4
26
+ with:
27
+ node-version: ${{ env.NODE_VERSION }}
28
+ - id: build-publish
29
+ uses: bitovi/github-actions-storybook-to-github-pages@v1.0.3
30
+ with:
31
+ install_command: pnpm install --frozen-lockfile
32
+ build_command: pnpm run storybook:build
33
+ path: dist/storybook
@@ -0,0 +1,65 @@
1
+ name: Release
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - master
7
+ - next
8
+ workflow_dispatch:
9
+
10
+ env:
11
+ NODE_VERSION: 22
12
+ PNPM_VERSION: 10.0.0
13
+
14
+ jobs:
15
+ release:
16
+ name: Build, Test and Release
17
+ runs-on: ubuntu-latest
18
+
19
+ steps:
20
+ - name: Checkout code
21
+ uses: actions/checkout@v4
22
+ with:
23
+ fetch-depth: 0
24
+ fetch-tags: true
25
+ - name: Enable Corepack
26
+ run: corepack enable
27
+
28
+ - name: Setup pnpm
29
+ uses: pnpm/action-setup@v4
30
+ with:
31
+ version: ${{ env.PNPM_VERSION }}
32
+ - name: Setup Node.js
33
+ uses: actions/setup-node@v4
34
+ with:
35
+ node-version: ${{ env.NODE_VERSION }}
36
+ - name: Get pnpm cache directory
37
+ id: pnpm-cache-dir
38
+ shell: bash
39
+ run: echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
40
+ - name: Generate cache key
41
+ id: cache-key
42
+ shell: bash
43
+ run: |
44
+ echo "key=node-v${{ env.NODE_VERSION }}-pnpm-v${{ env.PNPM_VERSION }}-lock-${{ hashFiles('**/pnpm-lock.yaml') }}" >> $GITHUB_OUTPUT
45
+ echo "restore_key=node-v${{ env.NODE_VERSION }}-pnpm-v${{ env.PNPM_VERSION }}-lock-" >> $GITHUB_OUTPUT
46
+ - name: Setup pnpm cache
47
+ uses: actions/cache@v4
48
+ with:
49
+ path: ${{ steps.pnpm-cache-dir.outputs.STORE_PATH }}
50
+ key: ${{ steps.cache-key.outputs.key }}
51
+ restore-keys: ${{ steps.cache-key.outputs.restore_key }}
52
+ - name: Install dependencies
53
+ run: pnpm install --frozen-lockfile
54
+ - name: Run linter
55
+ run: pnpm run lint
56
+ - name: Run tests
57
+ run: pnpm run test
58
+ - name: Build project
59
+ run: pnpm run build
60
+ - name: Run semantic-release
61
+ run: pnpm run semantic-release --debug
62
+ env:
63
+ HUSKY: 0
64
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
65
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
@@ -0,0 +1 @@
1
+ commitlint --edit ${1}
@@ -0,0 +1 @@
1
+ nano-staged
package/.nanostagedrc ADDED
@@ -0,0 +1,5 @@
1
+ {
2
+ "*.{ts,html}": ["eslint --fix"],
3
+ "*.{js,cjs,mjs,ts,mts,css,scss,html,json,md}": "prettier --write",
4
+ "*.{scss,css}": ["stylelint --fix"]
5
+ }
@@ -0,0 +1,3 @@
1
+ # Add files here to ignore them from prettier formatting
2
+ /dist
3
+ /coverage
package/.prettierrc ADDED
@@ -0,0 +1,23 @@
1
+ {
2
+ "plugins": [
3
+ "prettier-plugin-organize-attributes"
4
+ ],
5
+ "tabWidth": 2,
6
+ "useTabs": false,
7
+ "singleQuote": true,
8
+ "semi": true,
9
+ "bracketSpacing": true,
10
+ "arrowParens": "avoid",
11
+ "trailingComma": "es5",
12
+ "bracketSameLine": false,
13
+ "htmlWhitespaceSensitivity": "ignore",
14
+ "printWidth": 120,
15
+ "endOfLine": "auto",
16
+ "attributeGroups": [
17
+ "$ANGULAR_STRUCTURAL_DIRECTIVE",
18
+ "$ANGULAR_INPUT",
19
+ "$ANGULAR_OUTPUT",
20
+ "$ANGULAR_TWO_WAY_BINDING"
21
+ ],
22
+ "attributeSort": "ASC"
23
+ }
@@ -0,0 +1,67 @@
1
+ {
2
+ "$schema": "https://json.schemastore.org/semantic-release",
3
+ "branches": [
4
+ "master",
5
+ {
6
+ "name": "next",
7
+ "prerelease": true
8
+ }
9
+ ],
10
+ "plugins": [
11
+ [
12
+ "@semantic-release/commit-analyzer",
13
+ {
14
+ "preset": "conventionalcommits",
15
+ "presetConfig": {
16
+ "types": [
17
+ { "type": "feat", "section": "🚀 New Features", "hidden": false },
18
+ { "type": "fix", "section": "🐛 Bug Fixes", "hidden": false },
19
+ { "type": "perf", "section": "⚡️ Performance Improvements", "hidden": false },
20
+ { "type": "build", "section": "🏗️ Build Changes", "hidden": false },
21
+ { "type": "ci", "section": "🔄 Continuous Integration", "hidden": false },
22
+ { "type": "refactor", "section": "🛠️ Code Refactor", "hidden": false },
23
+ { "type": "test", "section": "✅ Tests", "hidden": false },
24
+ { "type": "chore", "section": "🧹 Chore", "hidden": true },
25
+ { "type": "docs", "section": "📚 Documentation", "hidden": false },
26
+ { "type": "style", "section": "🎨 Style", "hidden": true }
27
+ ]
28
+ }
29
+ }
30
+ ],
31
+ [
32
+ "@semantic-release/release-notes-generator",
33
+ {
34
+ "preset": "conventionalcommits",
35
+ "presetConfig": {
36
+ "types": [
37
+ { "type": "feat", "section": "🚀 New Features" },
38
+ { "type": "fix", "section": "🐛 Bug Fixes" },
39
+ { "type": "perf", "section": "⚡️ Performance Improvements" },
40
+ { "type": "build", "section": "🏗️ Build Changes" },
41
+ { "type": "ci", "section": "🔄 Continuous Integration" },
42
+ { "type": "refactor", "section": "🛠️ Code Refactor" },
43
+ { "type": "test", "section": "✅ Tests" },
44
+ { "type": "chore", "section": "🧹 Chore" },
45
+ { "type": "docs", "section": "📚 Documentation" },
46
+ { "type": "style", "section": "🎨 Style" }
47
+ ]
48
+ }
49
+ }
50
+ ],
51
+ [
52
+ "@semantic-release/changelog",
53
+ {
54
+ "changelogFile": "CHANGELOG.md"
55
+ }
56
+ ],
57
+ "@semantic-release/npm",
58
+ [
59
+ "@semantic-release/git",
60
+ {
61
+ "assets": ["package.json", "CHANGELOG.md", "pnpm-lock.yaml"],
62
+ "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
63
+ }
64
+ ],
65
+ "@semantic-release/github"
66
+ ]
67
+ }
@@ -0,0 +1,17 @@
1
+ import type { StorybookConfig } from '@storybook/angular';
2
+
3
+ const config: StorybookConfig = {
4
+ stories: ['./stories/**/*.@(js|jsx|ts|tsx|mdx)', '../src/schematics/**/*.stories.@(ts)'],
5
+ addons: [
6
+ '@storybook/addon-links',
7
+ '@storybook/addon-essentials',
8
+ '@chromatic-com/storybook',
9
+ '@storybook/addon-interactions',
10
+ ],
11
+ framework: '@storybook/angular',
12
+ docs: {
13
+ autodocs: true,
14
+ defaultName: 'Docs',
15
+ },
16
+ };
17
+ export default config;
@@ -0,0 +1,13 @@
1
+ import { setCompodocJson } from '@storybook/addon-docs/angular';
2
+ import type { Preview } from '@storybook/angular';
3
+
4
+ import docJson from '../documentation/documentation.json';
5
+ setCompodocJson(docJson);
6
+
7
+ const preview: Preview = {
8
+ parameters: {
9
+ layout: 'centered',
10
+ },
11
+ };
12
+
13
+ export default preview;
@@ -0,0 +1,9 @@
1
+ import ReadMe from '../../../README.md?raw';
2
+
3
+ import { Markdown } from '@storybook/blocks';
4
+
5
+ import { Meta } from '@storybook/blocks';
6
+
7
+ <Meta title="Welcome" />
8
+
9
+ <Markdown>{ReadMe}</Markdown>
@@ -0,0 +1,9 @@
1
+ import License from '../../../LICENSE?raw';
2
+
3
+ import { Markdown } from '@storybook/blocks';
4
+
5
+ import { Meta } from '@storybook/blocks';
6
+
7
+ <Meta title="License - BSD-2-Clause" />
8
+
9
+ <Markdown>{License}</Markdown>
@@ -0,0 +1,10 @@
1
+ {
2
+ "extends": "../tsconfig.lib.json",
3
+ "compilerOptions": {
4
+ "allowSyntheticDefaultImports": true,
5
+ "resolveJsonModule": true
6
+ },
7
+ "exclude": ["../**/*.spec.ts"],
8
+ "include": ["./preview.ts", "../src/**/*.stories.*", "../src/files/**/*.ts"],
9
+ "files": ["./typings.d.ts"]
10
+ }
@@ -0,0 +1,4 @@
1
+ declare module '*.md' {
2
+ const content: string;
3
+ export default content;
4
+ }
@@ -0,0 +1,3 @@
1
+ {
2
+ "extends": ["stylelint-config-standard-scss"]
3
+ }
package/CHANGELOG.md ADDED
@@ -0,0 +1,12 @@
1
+ ## [19.1.0-next.1](https://github.com/kstepien3/ng-zen/compare/v19.0.0...v19.1.0-next.1) (2025-04-06)
2
+
3
+ ### 🚀 New Features
4
+
5
+ * **switch:** add missing css variables ([0481ac7](https://github.com/kstepien3/ng-zen/commit/0481ac7d735eba4ee47fbc6a69cdee643f5b9b4c))
6
+
7
+ ### 🧹 Chore
8
+
9
+ * add conventional-changelog-conventionalcommits dependency ([c6d2342](https://github.com/kstepien3/ng-zen/commit/c6d23422c5866645b520f55dc3c10700fc268d06))
10
+ * change version alpha -> next ([aa5482c](https://github.com/kstepien3/ng-zen/commit/aa5482cd504a89e60eae07f6a3ea343ca8886e57))
11
+ * change version to v19.0.0-next.0 [skip ci] ([7ee3dbd](https://github.com/kstepien3/ng-zen/commit/7ee3dbd6d22a3d24c85fba0978c127f28c9248d4))
12
+ * fix problems with release ([a54af7a](https://github.com/kstepien3/ng-zen/commit/a54af7aa33259bb904df707f8450b39a1f8e00c9))
@@ -0,0 +1,30 @@
1
+ # Code of Conduct
2
+
3
+ The @ng-zen/cli project is committed to fostering an open and welcoming environment for all contributors and users. This Code of Conduct outlines the expectations for behavior within our community.
4
+
5
+ ## Our Pledge
6
+
7
+ We pledge to make participation in our project and community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
8
+
9
+ ## Our Standards
10
+
11
+ - **Be Respectful**: Treat others with respect and kindness, even when disagreeing.
12
+ - **Be Considerate**: Be mindful of the impact of your words and actions on others.
13
+ - **Be Open**: Be open to different perspectives and experiences.
14
+ - **Be Constructive**: Focus on constructive feedback and suggestions.
15
+
16
+ ## Unacceptable Behavior
17
+
18
+ - **Harassment**: Unwelcome comments or actions, including but not limited to those related to race, gender, or sexual orientation.
19
+ - **Spamming**: Posting irrelevant or repetitive content.
20
+ - **Trolling**: Posting inflammatory or off-topic messages.
21
+
22
+ ## Reporting Incidents
23
+
24
+ If you experience or witness any unacceptable behavior, please report it to the project maintainers via email at kord.stp@gmail.com.
25
+
26
+ ## Enforcement
27
+
28
+ The project maintainers are responsible for clarifying and enforcing our standards of acceptable behavior. They will take appropriate and fair corrective action in response to any instances of unacceptable behavior.
29
+
30
+ By participating in this project, you agree to abide by this Code of Conduct in all interactions related to the project.
@@ -0,0 +1,27 @@
1
+ # Contributing to @ng-zen/cli
2
+
3
+ Thank you for considering contributing to **@ng-zen/cli**! This project is maintained by Konrad Stępień and is open to contributions from the community.
4
+
5
+ ## How to Contribute
6
+
7
+ 1. **Fork the Repository**: Create a fork of the [ng-zen repository](https://github.com/Kordrad/ng-zen) on GitHub.
8
+ 2. **Create a Feature Branch**: Create a new branch for your feature or bug fix. Use a descriptive name for the branch, such as `feature/new-component` or `fix/documentation`.
9
+ 3. **Make Your Changes**: Implement your feature or fix. Ensure that your code adheres to the project's coding standards and best practices.
10
+ 4. **Write Tests**: If applicable, add unit tests or integration tests to cover your changes.
11
+ 5. **Submit a Pull Request**: Push your changes to your fork and submit a pull request to the main repository. Include a detailed description of your changes.
12
+
13
+ ## Contribution Guidelines
14
+
15
+ - **Code Quality**: Ensure that your code is well-formatted, readable, and follows Angular best practices.
16
+ - **Documentation**: Update documentation if necessary. Use JSDoc for code comments and ensure that Storybook examples are updated.
17
+ - **Testing**: Include tests for new functionality or bug fixes.
18
+ - **Commit Messages**: Use meaningful commit messages that follow the conventional commit format.
19
+
20
+ ## Communication
21
+
22
+ - **Issues**: If you encounter any issues or have questions, feel free to open an issue on GitHub.
23
+ - **Pull Request Reviews**: Be prepared to address feedback from maintainers during the review process.
24
+
25
+ ## Acknowledgments
26
+
27
+ Your contributions are invaluable to the growth and success of **@ng-zen/cli**. Thank you for your time and effort!
package/DEVELOPMENT.md ADDED
@@ -0,0 +1,80 @@
1
+ # Local Development Setup
2
+
3
+ This guide will help you set up a local development environment for **@ng-zen/cli**.
4
+
5
+ ## Prerequisites
6
+
7
+ - Node.js (preferably the latest LTS version)
8
+ - pnpm
9
+ - Angular CLI installed globally
10
+ - verdaccio
11
+
12
+ ## Working with Storybook
13
+
14
+ **Storybook** is the primary tool for developing and testing UI components. To start Storybook, run:
15
+
16
+ ```bash
17
+ pnpm run storybook
18
+ ```
19
+
20
+ This command will launch Storybook in your default browser, allowing you to interact with and test the components visually.
21
+
22
+ ### Building Storybook
23
+
24
+ To build a static version of Storybook for deployment, testing or release, use:
25
+
26
+ ```bash
27
+ pnpm run storybook:build
28
+ ```
29
+
30
+ ## Setting Up Verdaccio
31
+
32
+ 1. **Install Verdaccio**:
33
+ Follow the instructions on the [Verdaccio website](https://verdaccio.org/docs/installation#installing-the-cli) to install Verdaccio.
34
+
35
+ 2. **Start Local Registry**:
36
+ Run the following command to start the local registry:
37
+
38
+ ```bash
39
+ pnpm run verdaccio
40
+ ```
41
+
42
+ 3. **Configure npm to Use Local Registry**:
43
+ Follow the prompts from Verdaccio to configure npm to use the local registry.
44
+
45
+ ## Publishing Locally
46
+
47
+ 1. **Publish Package Locally**:
48
+ Use the following command to publish the package to your local registry:
49
+ ```bash
50
+ pnpm run publish:local
51
+ ```
52
+ 2. **Test in Angular Project**:
53
+ Add the package to an Angular project using the local registry:
54
+ ```bash
55
+ ng add @ng-zen/cli --registry http://localhost:4873/
56
+ ```
57
+
58
+ ## Running Tests
59
+
60
+ - **Unit Tests**: Run unit tests using the command:
61
+ ```bash
62
+ pnpm run test
63
+ ```
64
+ - **Linting**: Check code style and fix issues with:
65
+ ```bash
66
+ pnpm run lint
67
+ pnpm run lint:fix
68
+ ```
69
+
70
+ ## Building and Packaging
71
+
72
+ **Build** the project using:
73
+
74
+ ```bash
75
+ pnpm run build
76
+ ```
77
+
78
+ ---
79
+
80
+ By following these steps, you should be able to set up a fully functional local development environment for **@ng-zen/cli**.