@cargosense/cargo-design-system 1.0.14 → 1.0.15

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/package.json CHANGED
@@ -1,10 +1,7 @@
1
1
  {
2
2
  "name": "@cargosense/cargo-design-system",
3
- "version": "1.0.14",
3
+ "version": "1.0.15",
4
4
  "description": "",
5
- "workspaces": [
6
- "docs"
7
- ],
8
5
  "homepage": "https://github.com/CargoSense/cargo-design-system#readme",
9
6
  "bugs": {
10
7
  "url": "https://github.com/CargoSense/cargo-design-system/issues"
@@ -54,17 +51,15 @@
54
51
  "start": "vite testing",
55
52
  "build": "vite build",
56
53
  "test": "vitest run --coverage",
57
- "generate-icons": "node scripts/generate_imports.js",
58
- "docs": "npm run build --workspace=docs",
59
- "docs:dev": "npm run dev --workspace=docs"
54
+ "generate-icons": "node scripts/generate_imports.js"
60
55
  },
61
56
  "dependencies": {
62
57
  "lit": "^3.3.1",
63
- "vite": "^7.0.4"
58
+ "vite": "^7.1.9"
64
59
  },
65
60
  "devDependencies": {
66
61
  "@vitest/coverage-istanbul": "^3.2.4",
67
- "babel-plugin-istanbul": "^7.0.0",
62
+ "babel-plugin-istanbul": "^7.0.1",
68
63
  "vitest": "^3.2.3"
69
64
  },
70
65
  "files": [
package/LICENSE.md DELETED
@@ -1,9 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2025 CargoSense, Inc.
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
-
7
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
-
9
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md DELETED
@@ -1,93 +0,0 @@
1
- # CargoSense Design System
2
-
3
- This is the repository for the CargoSense Design System node package. The documentation for is hosted at https://docs.cargosense.com/design-system-docs.
4
-
5
- ## Usage
6
-
7
- Include these lines in your project:
8
-
9
- ```js
10
- // In your script.js file
11
- import { registerAllComponents } from '@cargosense/cargo-design-system/register'
12
- registerAllComponents();
13
-
14
- // Or to import a specific component
15
- import { registerButton } from '@cargosense/cargo-design-system/components'
16
- registerButton();
17
-
18
- import '@cargosense/cargo-design-system/fonts'; // Import fonts
19
- import "@cargosense/cargo-design-system/styles"; // Import CSS Variables
20
-
21
- ```
22
-
23
- ## Organization
24
-
25
- There are many different directory style structures for design systems, we will be adhering to a molecular structure where **atoms** are the smallest, most basic components (such as badges, icons, Key/Value pairs, etc). **Molecules** are larger components, usually those which rely on the smaller atom components to make up the bigger component as well. **Organisms** are either bigger components on the page or components that use several molecules/atoms. **Templates** are fully built out pages.
26
-
27
- ## Testing
28
-
29
- For testing/documentation, there is a simple React/Nextjs application built into the app, simply install the package using `npm install` and build it by running `npm run build`, then navigate to the docs folder and run `npm install` to update dependences and `npm run dev` which will automatically launch the documentation site. This should be used as both a playground for viewing and sampling components as well as a local place to develop new components.
30
-
31
- ### Unit Testing
32
-
33
- When creating a component, it is essential that a test file is created for a component that makes sure that it is being rendered correctly and all logic works before the component is added to the release.
34
-
35
- We use [vitest](https://vitest.dev) with [istanbul](https://github.com/istanbuljs/babel-plugin-istanbul) code coverage.
36
-
37
- ## Contributing
38
-
39
- You should **never** commit anything to the main branch. All additional changes past v1.0.0 should be committed to a seperate branch with the name of the component being created. This will then be merged into a release branch which when completed will be merged into main.
40
-
41
- All styling that might need to be changed later, such as spacing, coloring, borders, etc. should be turned into variables and then transferred into `css/variables.css` with clear commenting as to where these variables came from and what they are for. Any colors should refer to the `--base-color` variables already located at the beginning of the same css file.
42
-
43
- When creating a new component
44
- - Create a new component in the appopriate folder under `src/`, import the component into `./src/components/index.js`, build the app by running `npm run build`
45
- - Before creating a pull request, make sure to create file under `/docs/src/app/components/json` with the name of your component, then update the imports in the `index.js` file in the same folder. Use one of the existing json files as a template.
46
- - Note: if you want to make any changes to your component, you must run `npm run build` in the main directory to rebuild the `dist/` folder, which is what the `docs` app is importing.
47
-
48
- If you're just looking to work on your component and test things out but you're not ready for the final version, you can create a local `testing` folder with an html file to contain your custom component and a script tag to import the components you're working on. This will give you a completely open place to test your component which is quite helpful if it's bigger as well as allowing `vite` to make use of it's live reload feature.
49
-
50
-
51
- Component Template:
52
- ```json
53
- {
54
- "title": "",
55
- "name": "",
56
- "description": "",
57
- "figma": "",
58
- "category": "",
59
- "tags": [],
60
- "code": "",
61
- "properties": {
62
- "name": "Properties",
63
- "property": [],
64
- "attribute": [],
65
- "description": [],
66
- "values": [],
67
- "default": []
68
- },
69
- "slots": {
70
- "name": "Slots",
71
- "slot": [],
72
- "description": []
73
- },
74
- "methods": {
75
- "name": "Methods",
76
- "method": [],
77
- "description": [],
78
- "signagture": []
79
- },
80
- "cssVariables": {
81
- "name": "CSS Variables",
82
- "property": [],
83
- "description": [],
84
- "default": []
85
- },
86
- "dependencies": {}
87
- }
88
-
89
- ```
90
-
91
- ## License
92
-
93
- cargo-design-system is freely available under the [MIT License](https://opensource.org/licenses/MIT).