@ifloppy/maxcraftmc-ui-svelte 0.1.0 → 0.1.2

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 CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.2
4
+
5
+ - Added explicit AI-generated project notices.
6
+ - Removed internal/local consumer documentation from the public docs.
7
+ - Updated published package metadata and public usage snippets.
8
+
3
9
  ## 0.1.0
4
10
 
5
11
  Initial MaxCraft compatibility package.
package/README.md CHANGED
@@ -19,6 +19,13 @@ projects:
19
19
  The implementation is derived from Carbon Svelte 0.89.4 under Apache-2.0. The
20
20
  theme tokens and visual overrides are MaxCraft-specific.
21
21
 
22
+ ## AI Generated Notice
23
+
24
+ This project was generated entirely by AI. Treat it as experimental software:
25
+ review the source, dependency behavior, accessibility, security, and licensing
26
+ fit before using it in production. MaxCraft-specific styling and compatibility
27
+ claims should be validated in each consuming application.
28
+
22
29
  ## Install
23
30
 
24
31
  ```sh
@@ -31,18 +38,7 @@ alias after the package is published:
31
38
  ```json
32
39
  {
33
40
  "dependencies": {
34
- "carbon-components-svelte": "npm:@ifloppy/maxcraftmc-ui-svelte@0.1.0",
35
- "carbon-icons-svelte": "^13.5.0"
36
- }
37
- }
38
- ```
39
-
40
- During local development inside `mpc-solution`, use a file dependency:
41
-
42
- ```json
43
- {
44
- "dependencies": {
45
- "carbon-components-svelte": "file:../maxcraft-ui",
41
+ "carbon-components-svelte": "npm:@ifloppy/maxcraftmc-ui-svelte@0.1.2",
46
42
  "carbon-icons-svelte": "^13.5.0"
47
43
  }
48
44
  }
@@ -105,16 +101,6 @@ npm run build
105
101
  exist. `npm run build` also runs `npm pack --dry-run` to prove the package can be
106
102
  published.
107
103
 
108
- ## Consumer Status
109
-
110
- Current local consumers in `mpc-solution`:
111
-
112
- - `mpc-web`: SvelteKit app using the component package through a local file alias.
113
- - `maxcraftmc-wiki`: Hugo site using `css/maxcraft.css` through Hugo module mounts.
114
-
115
- Use [Consumer migration checklist](docs/consumer-checklist.md) when adding new
116
- apps or moving consumers from local file aliases to the published npm package.
117
-
118
104
  ## Attribution
119
105
 
120
106
  The component source and type surface are derived from
@@ -31,6 +31,8 @@ cannot see.
31
31
  - This package does not replace `carbon-icons-svelte`.
32
32
  - This package does not guarantee visual parity with IBM Carbon; MaxCraft visual
33
33
  language is the intended output.
34
+ - This package does not provide a human-authored guarantee of correctness. It
35
+ was generated entirely by AI and must be reviewed before production use.
34
36
 
35
37
  ## Adding Or Changing Components
36
38
 
@@ -39,7 +41,6 @@ Before changing a component API:
39
41
  1. Compare against `carbon-components-svelte@0.89.4`.
40
42
  2. Preserve existing prop/event/slot names unless a breaking release is planned.
41
43
  3. Run `npm run check`.
42
- 4. Verify `mpc-web` with `npm run check` and `npm run build`.
43
44
 
44
45
  If a component needs MaxCraft-specific behavior, prefer CSS/token customization
45
46
  first. Add new props only when CSS cannot express the requirement.
@@ -5,26 +5,25 @@ Use this checklist when connecting a Svelte or Hugo consumer to
5
5
 
6
6
  ## Svelte Consumer
7
7
 
8
- - Replace `carbon-components-svelte` with a local file alias during development:
9
- `file:../maxcraft-ui`.
10
- - Replace the local alias with `npm:@ifloppy/maxcraftmc-ui-svelte@<version>` after
11
- publishing.
8
+ - Replace `carbon-components-svelte` with
9
+ `npm:@ifloppy/maxcraftmc-ui-svelte@<version>`.
12
10
  - Keep `carbon-icons-svelte` installed.
13
11
  - Remove `carbon-components` unless the app imports it directly.
14
12
  - Import `carbon-components-svelte/css/all.css` once in the root layout.
15
13
  - Import `carbon-components-svelte/css/maxcraft.css` once after `all.css`.
16
14
  - Keep existing component imports unchanged when using the alias.
17
15
  - Run `npm install --ignore-scripts`.
18
- - During local file-link development, also run `npm install --ignore-scripts`
19
- inside `maxcraft-ui`.
20
16
  - Run `npm run check`.
21
17
  - Run `npm run build`.
22
18
  - Manually verify navigation, form controls, modals, notifications, tiles, tags,
23
19
  and dark mode.
20
+ - Because this package was generated entirely by AI, review source behavior,
21
+ accessibility, security, and compatibility in the consumer app before
22
+ production use.
24
23
 
25
24
  ## Hugo Consumer
26
25
 
27
- - Import `github.com/FloppyBetaStudio/maxcraft-ui` as a Hugo module and mount
26
+ - Import `github.com/ifloppy/maxcraftmc-ui-svelte` as a Hugo module and mount
28
27
  its `css` directory to `assets/maxcraft-ui`.
29
28
  - If adding project-level mounts, explicitly restore default mounts for
30
29
  `assets`, `content`, `layouts`, `static`, and any other site folders in use.
@@ -36,7 +35,7 @@ Use this checklist when connecting a Svelte or Hugo consumer to
36
35
 
37
36
  ## Release Consumer
38
37
 
39
- - Update the consumer lockfile after changing from `file:` to `npm:`.
38
+ - Update the consumer lockfile after changing package versions.
40
39
  - Run consumer checks after every package version bump.
41
40
  - Check for accidental duplicate CSS imports.
42
41
  - Keep `carbon-icons-svelte` version compatible with the consuming app.
@@ -10,14 +10,6 @@ npm install --ignore-scripts
10
10
  npm run check
11
11
  ```
12
12
 
13
- When developing against `mpc-web`:
14
-
15
- ```sh
16
- cd ../mpc-web
17
- npm install --ignore-scripts
18
- npm run check
19
- ```
20
-
21
13
  ## What To Change First
22
14
 
23
15
  - For visual work, prefer `tokens/maxcraft.css` and `css/maxcraft.css`.
@@ -45,7 +37,7 @@ npm run check
45
37
 
46
38
  ## Verification
47
39
 
48
- Run from `maxcraft-ui`:
40
+ Run from the package root:
49
41
 
50
42
  ```sh
51
43
  npm run check
@@ -61,20 +53,8 @@ The local checks cover:
61
53
  - CSS entrypoint existence
62
54
  - documentation and README link integrity
63
55
 
64
- Run consumers when shared CSS or package metadata changes:
65
-
66
- ```sh
67
- cd ../mpc-web
68
- npm run check
69
- npm run build
70
-
71
- cd ../maxcraftmc-wiki
72
- hugo --gc --minify
73
- ```
74
-
75
- ## GitNexus
56
+ ## AI Generated Notice
76
57
 
77
- When editing existing symbols, run impact analysis before changes and
78
- `gitnexus detect-changes` before committing. Documentation-only changes usually
79
- do not map to symbols, but still run detect-changes before commit when the root
80
- repository requires it.
58
+ This project was generated entirely by AI. Contributions and releases should
59
+ include human review for source correctness, accessibility, security, licensing,
60
+ and compatibility before production use.
@@ -15,7 +15,7 @@ Then import the public MaxCraft UI module and mount its CSS directory:
15
15
 
16
16
  ```toml
17
17
  [[module.imports]]
18
- path = "github.com/FloppyBetaStudio/maxcraft-ui"
18
+ path = "github.com/ifloppy/maxcraftmc-ui-svelte"
19
19
 
20
20
  [[module.imports.mounts]]
21
21
  source = "css"
@@ -61,13 +61,13 @@ Include `maxcraft.css` before site-specific overrides:
61
61
  {{ end }}
62
62
  ```
63
63
 
64
- For `maxcraftmc-wiki`, the intended order is:
64
+ The intended order is:
65
65
 
66
- 1. Tailbliss/Tailwind base CSS
66
+ 1. Site base CSS
67
67
  2. `maxcraft-ui/maxcraft.css`
68
- 3. Wiki-specific `css/site.css`
68
+ 3. Site-specific overrides
69
69
 
70
- This order gives the wiki the shared tokens while preserving its custom page
70
+ This order gives the site the shared tokens while preserving its custom page
71
71
  layouts and animations.
72
72
 
73
73
  ## 3. Use Shared Tokens
@@ -7,6 +7,9 @@ This package supports two consumption modes:
7
7
 
8
8
  ## Published Package
9
9
 
10
+ This project was generated entirely by AI. Review the code, behavior,
11
+ accessibility, security, and licensing fit before relying on it in production.
12
+
10
13
  Install the package and keep `carbon-icons-svelte` as the icon source:
11
14
 
12
15
  ```sh
@@ -27,7 +30,7 @@ unchanged:
27
30
  ```json
28
31
  {
29
32
  "dependencies": {
30
- "carbon-components-svelte": "npm:@ifloppy/maxcraftmc-ui-svelte@0.1.0",
33
+ "carbon-components-svelte": "npm:@ifloppy/maxcraftmc-ui-svelte@0.1.2",
31
34
  "carbon-icons-svelte": "^13.5.0"
32
35
  }
33
36
  }
@@ -41,34 +44,6 @@ import "carbon-components-svelte/css/all.css";
41
44
  import "carbon-components-svelte/css/maxcraft.css";
42
45
  ```
43
46
 
44
- ## Local Development In mpc-solution
45
-
46
- Use the local file alias while editing the UI package beside consumers:
47
-
48
- ```json
49
- {
50
- "dependencies": {
51
- "carbon-components-svelte": "file:../maxcraft-ui",
52
- "carbon-icons-svelte": "^13.5.0"
53
- }
54
- }
55
- ```
56
-
57
- Then install in both projects:
58
-
59
- ```sh
60
- cd maxcraft-ui
61
- npm install --ignore-scripts
62
-
63
- cd ../mpc-web
64
- npm install --ignore-scripts
65
- ```
66
-
67
- The `maxcraft-ui` install is needed during local file-link development because
68
- Vite resolves package source files through the real path and dependencies such
69
- as `flatpickr` must exist beside that source tree. Published npm installs do not
70
- need this extra step.
71
-
72
47
  ## Required CSS Entrypoints
73
48
 
74
49
  The package preserves Carbon's original CSS entrypoints:
@@ -5,14 +5,12 @@
5
5
  The intended public repository is:
6
6
 
7
7
  ```sh
8
- github1:FloppyBetaStudio/maxcraft-ui.git
8
+ https://github.com/ifloppy/maxcraftmc-ui-svelte.git
9
9
  ```
10
10
 
11
- The root `mpc-solution` repository tracks this directory as a Git submodule.
12
-
13
11
  ## Pre-Publish Checks
14
12
 
15
- Run from `maxcraft-ui`:
13
+ Run:
16
14
 
17
15
  ```sh
18
16
  npm install --ignore-scripts
@@ -24,18 +22,6 @@ npm run build
24
22
  The check step verifies API parity, export targets, a Vite/Svelte smoke build,
25
23
  placeholder markers, CSS entrypoints, and documentation links.
26
24
 
27
- Also verify consumers:
28
-
29
- ```sh
30
- cd ../mpc-web
31
- npm install --ignore-scripts
32
- npm run check
33
- npm run build
34
-
35
- cd ../maxcraftmc-wiki
36
- hugo --gc --minify
37
- ```
38
-
39
25
  ## Publish
40
26
 
41
27
  After the package is ready:
@@ -49,11 +35,17 @@ Then update consumers from local file aliases to npm aliases:
49
35
  ```json
50
36
  {
51
37
  "dependencies": {
52
- "carbon-components-svelte": "npm:@ifloppy/maxcraftmc-ui-svelte@0.1.0"
38
+ "carbon-components-svelte": "npm:@ifloppy/maxcraftmc-ui-svelte@0.1.2"
53
39
  }
54
40
  }
55
41
  ```
56
42
 
43
+ ## AI Generated Notice
44
+
45
+ This package was generated entirely by AI. Each release should be reviewed for
46
+ source correctness, accessibility, security, licensing, and compatibility before
47
+ production use.
48
+
57
49
  ## Attribution Requirements
58
50
 
59
51
  Keep these files in every published package:
@@ -70,5 +62,4 @@ from `carbon-components-svelte@0.89.4`, which is Apache-2.0 licensed.
70
62
  - Keep `css/maxcraft.css` self-contained for Hugo.
71
63
  - Keep `tokens/maxcraft.css` as the token source for future tooling.
72
64
  - Run API and CSS entrypoint checks before every release.
73
- - Test `mpc-web` and `maxcraftmc-wiki` before bumping the package version.
74
65
  - Avoid introducing a dependency on Carbon icons beyond `carbon-icons-svelte`.
@@ -1,27 +1,15 @@
1
1
  # Svelte Migration Guide
2
2
 
3
- This guide is for apps already using `carbon-components-svelte@0.89.4`, such as
4
- `mpc-web`.
3
+ This guide is for apps already using `carbon-components-svelte@0.89.4`.
5
4
 
6
5
  ## 1. Replace The Dependency
7
6
 
8
- Local development:
9
-
10
- ```json
11
- {
12
- "dependencies": {
13
- "carbon-components-svelte": "file:../maxcraft-ui",
14
- "carbon-icons-svelte": "^13.5.0"
15
- }
16
- }
17
- ```
18
-
19
7
  Published package:
20
8
 
21
9
  ```json
22
10
  {
23
11
  "dependencies": {
24
- "carbon-components-svelte": "npm:@ifloppy/maxcraftmc-ui-svelte@0.1.0",
12
+ "carbon-components-svelte": "npm:@ifloppy/maxcraftmc-ui-svelte@0.1.2",
25
13
  "carbon-icons-svelte": "^13.5.0"
26
14
  }
27
15
  }
@@ -29,6 +17,8 @@ Published package:
29
17
 
30
18
  Remove the old `carbon-components` dependency unless the app imports it
31
19
  directly. `@ifloppy/maxcraftmc-ui-svelte` includes the CSS entrypoints it needs.
20
+ This project was generated entirely by AI, so review compatibility and behavior
21
+ in the consuming app before production use.
32
22
 
33
23
  ## 2. Keep Component Imports
34
24
 
@@ -109,15 +99,3 @@ Manually inspect:
109
99
  - Tiles and tags
110
100
  - Light/dark theme switching
111
101
  - Mobile layout
112
-
113
- ## Known Local Development Detail
114
-
115
- When using `file:../maxcraft-ui`, install dependencies in `maxcraft-ui` itself:
116
-
117
- ```sh
118
- cd ../maxcraft-ui
119
- npm install --ignore-scripts
120
- ```
121
-
122
- This avoids Vite resolution failures for transitive dependencies such as
123
- `flatpickr`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ifloppy/maxcraftmc-ui-svelte",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "license": "Apache-2.0",
5
5
  "description": "MaxCraft themed compatibility build of carbon-components-svelte 0.89.4.",
6
6
  "type": "module",
@@ -69,7 +69,7 @@
69
69
  },
70
70
  "repository": {
71
71
  "type": "git",
72
- "url": "git+ssh://github1:FloppyBetaStudio/maxcraft-ui.git"
72
+ "url": "https://github.com/ifloppy/maxcraftmc-ui-svelte.git"
73
73
  },
74
74
  "keywords": [
75
75
  "carbon",