pdap-design-system 2.0.5 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +41 -15
- package/bin/pdap-design-system-cli.js +1 -1
- package/dist/config/index.d.ts +2 -0
- package/dist/index.cjs +3 -3
- package/dist/index.js +429 -347
- package/dist/{index.d.ts → src/index.d.ts} +1 -0
- package/dist/tailwind.config.d.ts +2 -0
- package/docs/CONTRIBUTING.md +64 -0
- package/docs/components.md +555 -0
- package/package.json +42 -14
- package/CONTRIBUTING.md +0 -34
- package/dist/tools/testing/serializer.d.ts +0 -7
- package/dist/tools/testing/setup.d.ts +0 -1
- /package/dist/{components → src/components}/Button/PdapButton.vue.d.ts +0 -0
- /package/dist/{components → src/components}/Button/index.d.ts +0 -0
- /package/dist/{components → src/components}/Button/types.d.ts +0 -0
- /package/dist/{components → src/components}/FlexContainer/FlexContainer.vue.d.ts +0 -0
- /package/dist/{components → src/components}/FlexContainer/index.d.ts +0 -0
- /package/dist/{components → src/components}/FlexContainer/types.d.ts +0 -0
- /package/dist/{components → src/components}/Footer/PdapFooter.vue.d.ts +0 -0
- /package/dist/{components → src/components}/Footer/index.d.ts +0 -0
- /package/dist/{components → src/components}/Footer/types.d.ts +0 -0
- /package/dist/{components → src/components}/Form/PdapForm.vue.d.ts +0 -0
- /package/dist/{components → src/components}/Form/index.d.ts +0 -0
- /package/dist/{components → src/components}/Form/types.d.ts +0 -0
- /package/dist/{components → src/components}/GridContainer/GridContainer.vue.d.ts +0 -0
- /package/dist/{components → src/components}/GridContainer/index.d.ts +0 -0
- /package/dist/{components → src/components}/GridContainer/types.d.ts +0 -0
- /package/dist/{components → src/components}/GridItem/GridItem.vue.d.ts +0 -0
- /package/dist/{components → src/components}/GridItem/index.d.ts +0 -0
- /package/dist/{components → src/components}/GridItem/types.d.ts +0 -0
- /package/dist/{components → src/components}/Header/PdapHeader.vue.d.ts +0 -0
- /package/dist/{components → src/components}/Header/index.d.ts +0 -0
- /package/dist/{components → src/components}/Header/types.d.ts +0 -0
- /package/dist/{components → src/components}/Input/PdapInput.vue.d.ts +0 -0
- /package/dist/{components → src/components}/Input/index.d.ts +0 -0
- /package/dist/{components → src/components}/Input/types.d.ts +0 -0
- /package/dist/{components → src/components}/Input/utils.d.ts +0 -0
- /package/dist/{components → src/components}/Nav/PdapNav.vue.d.ts +0 -0
- /package/dist/{components → src/components}/Nav/index.d.ts +0 -0
- /package/dist/{components → src/components}/Nav/types.d.ts +0 -0
- /package/dist/{components → src/components}/QuickSearchForm/QuickSearchForm.vue.d.ts +0 -0
- /package/dist/{components → src/components}/QuickSearchForm/index.d.ts +0 -0
- /package/dist/{components → src/components}/TileIcon/TileIcon.vue.d.ts +0 -0
- /package/dist/{components → src/components}/TileIcon/index.d.ts +0 -0
- /package/dist/{components → src/components}/TileIcon/types.d.ts +0 -0
- /package/dist/{components → src/components}/index.d.ts +0 -0
- /package/dist/{utils → src/utils}/vuelidate.d.ts +0 -0
- /package/dist/{utils → src/utils}/vuelidate.test.d.ts +0 -0
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "pdap-design-system",
|
3
|
-
"version": "2.0
|
3
|
+
"version": "2.1.0",
|
4
4
|
"description": "Global styles for PDAP apps",
|
5
5
|
"author": "Police Data Accessibility Project, Inc.",
|
6
6
|
"license": "ISC",
|
@@ -44,6 +44,11 @@
|
|
44
44
|
]
|
45
45
|
},
|
46
46
|
"devDependencies": {
|
47
|
+
"@commitlint/cli": "^18.4.3",
|
48
|
+
"@commitlint/config-conventional": "^18.4.3",
|
49
|
+
"@semantic-release/changelog": "^6.0.3",
|
50
|
+
"@semantic-release/git": "^10.0.1",
|
51
|
+
"@semantic-release/release-notes-generator": "^12.1.0",
|
47
52
|
"@types/node": "^20.8.9",
|
48
53
|
"@typescript-eslint/eslint-plugin": "^6.9.1",
|
49
54
|
"@typescript-eslint/parser": "^6.9.1",
|
@@ -53,16 +58,23 @@
|
|
53
58
|
"@vue/eslint-config-typescript": "^12.0.0",
|
54
59
|
"@vue/test-utils": "^2.4.1",
|
55
60
|
"autoprefixer": "^10.4.16",
|
61
|
+
"conventional-changelog-angular": "^7.0.0",
|
56
62
|
"cross-env": "^7.0.3",
|
63
|
+
"cz-conventional-changelog": "^3.3.0",
|
57
64
|
"eslint": "^8.53.0",
|
58
65
|
"eslint-config-prettier": "^9.0.0",
|
59
66
|
"eslint-plugin-vue": "^9.18.1",
|
67
|
+
"husky": "^8.0.0",
|
60
68
|
"jest-serializer-vue-tjw": "^3.20.0",
|
69
|
+
"lint-staged": "^15.2.0",
|
61
70
|
"npm-run-all": "^4.1.5",
|
62
71
|
"prettier": "^3.0.3",
|
63
72
|
"rimraf": "^5.0.5",
|
73
|
+
"semantic-release": "^22.0.10",
|
74
|
+
"semantic-release-github-pullrequest": "^1.3.0",
|
64
75
|
"stylelint": "^15.11.0",
|
65
76
|
"stylelint-config-standard": "^34.0.0",
|
77
|
+
"stylelint-config-standard-vue": "^1.0.0",
|
66
78
|
"tailwindcss": "^3.3.3",
|
67
79
|
"typescript": "^5.2.2",
|
68
80
|
"vite": "^4.5.0",
|
@@ -80,29 +92,45 @@
|
|
80
92
|
"vue-router": "^4.2.5"
|
81
93
|
},
|
82
94
|
"scripts": {
|
95
|
+
"_commit": "cz",
|
83
96
|
"build": "vite build && vue-tsc",
|
84
97
|
"build:watch": "npm run build -- --watch",
|
85
|
-
"
|
98
|
+
"ci": "npm run clean && npm ci",
|
99
|
+
"clean": "run-p clean:*",
|
100
|
+
"clean:deps": "rimraf node_modules",
|
101
|
+
"clean:build": "rimraf coverage test/report dist",
|
102
|
+
"clean:test": "rimraf coverage test/report",
|
86
103
|
"lint": "run-p lint:*",
|
104
|
+
"lint:css": "stylelint 'src/**/*.{css,vue}'",
|
87
105
|
"lint:es": "eslint src --ext .ts .",
|
88
|
-
"lint:
|
89
|
-
"postbuild": "
|
90
|
-
"prepare": "
|
91
|
-
"prepublishOnly": "npm run build",
|
106
|
+
"lint:ts": "vue-tsc",
|
107
|
+
"postbuild": "run-p clean:test && rimraf dist/{config,utils}",
|
108
|
+
"prepare": "husky install",
|
92
109
|
"test": "vitest --dom --run --coverage",
|
93
|
-
"test:changed": "npm run test --changed",
|
94
|
-
"
|
110
|
+
"test:changed": "npm run test -- --changed",
|
111
|
+
"test:ci": "test --watchAll=false",
|
112
|
+
"typecheck": "vue-tsc"
|
95
113
|
},
|
114
|
+
"bin": {
|
115
|
+
"pdap-design-system": "./bin/pdap-design-system-cli.js"
|
116
|
+
},
|
117
|
+
"keywords": [
|
118
|
+
"pdap-design-system"
|
119
|
+
],
|
96
120
|
"files": [
|
97
121
|
"bin",
|
98
|
-
"CONTRIBUTING.md",
|
99
122
|
"dist",
|
123
|
+
"docs",
|
124
|
+
"package.json",
|
100
125
|
"README.md"
|
101
126
|
],
|
102
|
-
"
|
103
|
-
"
|
127
|
+
"publishConfig": {
|
128
|
+
"registry": "https://registry.npmjs.org/",
|
129
|
+
"tag": "latest"
|
104
130
|
},
|
105
|
-
"
|
106
|
-
"
|
107
|
-
|
131
|
+
"config": {
|
132
|
+
"commitizen": {
|
133
|
+
"path": "./node_modules/cz-conventional-changelog"
|
134
|
+
}
|
135
|
+
}
|
108
136
|
}
|
package/CONTRIBUTING.md
DELETED
@@ -1,34 +0,0 @@
|
|
1
|
-
# Contributing
|
2
|
-
|
3
|
-
## Tech Stack
|
4
|
-
|
5
|
-
This is a `Vue` component library. It is built using `Vue3` and the `composition` API with TypeScript. Styles are created using `TailwindCSS`. The library is built using `Vite`. For testing, we use `Vitest`, for linting `eslint`, for formatting `prettier`
|
6
|
-
Some helpful resources and reading:
|
7
|
-
|
8
|
-
[Vue.js docs](https://vuejs.org/guide/introduction.html)
|
9
|
-
[Vite docs](https://vitejs.dev/guide/)
|
10
|
-
[Vitest docs](https://vitest.dev/guide/)
|
11
|
-
[Vue Testing Handbook](https://lmiller1990.github.io/vue-testing-handbook/v3/)
|
12
|
-
[Tailwind docs](https://tailwindui.com/documentation)
|
13
|
-
[TypeScript docs](https://www.typescriptlang.org/docs/)
|
14
|
-
|
15
|
-
### Etiquette
|
16
|
-
|
17
|
-
Head to [\#outreach](https://discord.com/channels/828274060034965575/853442226034442260/) in our [Discord](https://discord.gg/vKhDv7nC8B) if you'd like to collect feedback from the wider group.
|
18
|
-
|
19
|
-
Test your changes **locally first**, if possible. Include **screenshots with your PR** if you're changing something visual.
|
20
|
-
|
21
|
-
### Setup
|
22
|
-
|
23
|
-
1. [Clone the repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
|
24
|
-
|
25
|
-
For PDAP staff: Make changes as needed, but consider how widely this is used. Don't merge things until we test the changes.
|
26
|
-
|
27
|
-
For the public: This is an internal system, but it could easily be forked and altered to meet your needs. Feel free to share potentially useful things back to us in a Pull Request.
|
28
|
-
|
29
|
-
To test the package locally:
|
30
|
-
|
31
|
-
1. Run `npm link` from the root of the project directory.
|
32
|
-
2. `cd` into the local directory of the app you want to test importing into, then run `npm link pdap-design-system`
|
33
|
-
3. This will create a symlink between your local directories, allowing you to test changes in real time without actually publishing to the `npm` registry.
|
34
|
-
4. To test publishing your changes, run `npm publish --dry-run`. The console will output the result of the `publish` method, if you had actually called it.
|
@@ -1 +0,0 @@
|
|
1
|
-
export {};
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|