chore: improve workflows

- Add standard-version to automate version bumping, adding tag, and writing changelog
- remove husky
- add lint script
- update CI pipeline to include linting for pull requests
- format yet-linted files
- add Enrico to contributors
This commit is contained in:
Enrico Sacchetti 2023-01-11 21:15:38 -05:00
commit 15185040ed
No known key found for this signature in database
GPG key ID: 3374B89ECA60D796
7 changed files with 1072 additions and 413 deletions

View file

@ -17,8 +17,9 @@ jobs:
path: "**/node_modules" path: "**/node_modules"
key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }} key: ${{ runner.os }}-modules-${{ hashFiles('**/yarn.lock') }}
- name: Install dependencies and build the library - name: Install dependencies, build, test, and lint the codebase
run: | run: |
yarn yarn
yarn build:lib yarn build:lib
yarn test:types yarn test:types
yarn lint

View file

@ -1,8 +1,9 @@
/lib /lib
/css /css
/types
.svelte-kit .svelte-kit
.routify .routify
dist dist
client client
build build
*.svx *.svx

View file

@ -12,12 +12,13 @@
], ],
"scripts": { "scripts": {
"test:types": "svelte-check --workspace tests", "test:types": "svelte-check --workspace tests",
"lint": "prettier --write \"**/*.{svelte,md,js,json,ts}\"",
"build:css": "node scripts/build-css", "build:css": "node scripts/build-css",
"build:docs": "node scripts/build-docs", "build:docs": "node scripts/build-docs",
"build:lib": "rollup -c", "build:lib": "rollup -c",
"prepack": "yarn build:docs & yarn build:lib",
"format": "prettier --write \"./**/*.{svelte,js,md}\"", "format": "prettier --write \"./**/*.{svelte,js,md}\"",
"prepare": "husky install" "prepack": "yarn build:docs & yarn build:lib",
"release": "standard-version"
}, },
"dependencies": { "dependencies": {
"flatpickr": "4.6.9" "flatpickr": "4.6.9"
@ -29,8 +30,6 @@
"autoprefixer": "^10.4.8", "autoprefixer": "^10.4.8",
"carbon-components": "10.56.0", "carbon-components": "10.56.0",
"carbon-icons-svelte": "^11.2.0", "carbon-icons-svelte": "^11.2.0",
"husky": "^8.0.1",
"lint-staged": "^13.0.3",
"postcss": "^8.4.16", "postcss": "^8.4.16",
"prettier": "^2.7.1", "prettier": "^2.7.1",
"prettier-plugin-svelte": "^2.7.0", "prettier-plugin-svelte": "^2.7.0",
@ -38,17 +37,12 @@
"rollup-plugin-svelte": "^7.1.0", "rollup-plugin-svelte": "^7.1.0",
"rollup-plugin-terser": "^7.0.2", "rollup-plugin-terser": "^7.0.2",
"sass": "^1.49.11", "sass": "^1.49.11",
"standard-version": "^9.5.0",
"sveld": "^0.18.0", "sveld": "^0.18.0",
"svelte": "^3.51.0", "svelte": "^3.51.0",
"svelte-check": "^2.8.1", "svelte-check": "^2.8.1",
"typescript": "^4.7.4" "typescript": "^4.7.4"
}, },
"lint-staged": {
"*.{svelte,md,js,json}": [
"prettier --write"
],
"*.{svelte,js,md}": "prettier --write"
},
"prettier": { "prettier": {
"svelteStrictMode": true "svelteStrictMode": true
}, },
@ -73,6 +67,6 @@
], ],
"contributors": [ "contributors": [
"Eric Liu (https://github.com/metonym)", "Eric Liu (https://github.com/metonym)",
"Josef Aidt (https://github.com/josefaidt)" "Enrico Sacchetti (https://github.com/theetrain)"
] ]
} }

View file

@ -1,28 +1,28 @@
import type { Readable, Subscriber, Unsubscriber } from "svelte/store"; import type { Readable, Subscriber, Unsubscriber } from "svelte/store";
import type { BreakpointSize, BreakpointValue } from "./breakpoints"; import type { BreakpointSize, BreakpointValue } from "./breakpoints";
/** /**
* Creates a readable store that returns the current breakpoint size. * Creates a readable store that returns the current breakpoint size.
* It also provides functions for creating derived stores used to do comparisons. * It also provides functions for creating derived stores used to do comparisons.
*/ */
export function breakpointObserver(): { export function breakpointObserver(): {
subscribe: ( subscribe: (
this: void, this: void,
run: Subscriber<any>, run: Subscriber<any>,
invalidate?: (value?: any) => void invalidate?: (value?: any) => void
) => Unsubscriber; ) => Unsubscriber;
/** /**
* Returns a store readable store that returns whether the current * Returns a store readable store that returns whether the current
* breakpoint is smaller than {@link size}. * breakpoint is smaller than {@link size}.
* @param {BreakpointSize} size Size to compare against. * @param {BreakpointSize} size Size to compare against.
*/ */
smallerThan: (size: BreakpointSize) => Readable<boolean>; smallerThan: (size: BreakpointSize) => Readable<boolean>;
/** /**
* Returns a store readable store that returns whether the current * Returns a store readable store that returns whether the current
* breakpoint is larger than {@link size}. * breakpoint is larger than {@link size}.
* @param {BreakpointSize} size Size to compare against. * @param {BreakpointSize} size Size to compare against.
*/ */
largerThan: (size: BreakpointSize) => Readable<boolean>; largerThan: (size: BreakpointSize) => Readable<boolean>;
}; };
export default breakpointObserver; export default breakpointObserver;

View file

@ -1,11 +1,11 @@
/** /**
* Pixel sizes of Carbon grid breakpoints. * Pixel sizes of Carbon grid breakpoints.
* @type {Record<BreakpointSize, BreakpointValue>} * @type {Record<BreakpointSize, BreakpointValue>}
*/ */
export const breakpoints: Record<BreakpointSize, BreakpointValue>; export const breakpoints: Record<BreakpointSize, BreakpointValue>;
export type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max"; export type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max";
export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584; export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584;
export default breakpoints; export default breakpoints;

View file

@ -1,3 +1,3 @@
export { default as Breakpoint } from "./Breakpoint.svelte"; export { default as Breakpoint } from "./Breakpoint.svelte";
export { breakpointObserver } from "./breakpointObserver"; export { breakpointObserver } from "./breakpointObserver";
export { breakpoints } from "./breakpoints"; export { breakpoints } from "./breakpoints";

1379
yarn.lock

File diff suppressed because it is too large Load diff