From a4ef8d2db303b3abb875e3d09f3b85a53fdb432f Mon Sep 17 00:00:00 2001 From: Enrico Sacchetti Date: Fri, 13 Jan 2023 14:07:01 -0500 Subject: [PATCH] chore: update guide and scripts lint files --- CHANGELOG.md | 12 +++-- CONTRIBUTING.md | 38 ++++++++++++++++ package.json | 7 ++- types/Breakpoint/breakpointObserver.d.ts | 56 ++++++++++++------------ types/Breakpoint/breakpoints.d.ts | 22 +++++----- types/Breakpoint/index.d.ts | 6 +-- 6 files changed, 94 insertions(+), 47 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7742f8d4..03416fbc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,11 +1,15 @@ # Changelog -All notable changes to this project will be documented in this file. +All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), -and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### [0.71.2](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.71.0...v0.71.2) (2023-01-13) - + +### Features + +* some thing ([1f7a0b3](https://github.com/carbon-design-system/carbon-components-svelte/commit/1f7a0b3a30d28bf725d8d1e23a11148dfbad73d2)) + +### [0.71.1](https://github.com/carbon-design-system/carbon-components-svelte/compare/v0.71.0...v0.71.1) (2023-01-13) ## [0.71.0](https://github.com/carbon-design-system/carbon-components-svelte/releases/tag/v0.71.0) - 2022-12-31 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2810f2cc..0de228a9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,19 @@ Before submitting a pull request (PR), consider [filing an issue](https://github.com/carbon-design-system/carbon-components-svelte/issues) to gain clarity and direction. +- [Prerequisites](#prerequisites) +- [Project set-up](#project-set-up) + - [Install](#install) +- [Documentation set-up](#documentation-set-up) +- [Development workflow](#development-workflow) + - [Component Format](#component-format) + - [Editing a component](#editing-a-component) + - [Creating a component](#creating-a-component) + - [Run `yarn build:docs`](#run-yarn-builddocs) +- [Submit a Pull Request](#submit-a-pull-request) + - [Sync Your Fork](#sync-your-fork) + - [Submit a PR](#submit-a-pr) + ## Prerequisites - [Node.js](https://nodejs.org/en/download/package-manager/) (version >=12) @@ -145,3 +158,28 @@ git merge upstream/master ### Submit a PR After you've pushed your changes to remote, submit your PR. Make sure you are comparing `/feature` to `origin/master`. + +## Release + +Locally, while on `master` and the branch is clean, run `yarn release`. This command will: + +- Build library and docs +- Bump package.json version +- Add notes to Changelog + +Afterwards, perform the following manually: + +```sh +# 1. Stage prepared files for a commit +git add . + +# 2. Commit based on the current version, either manually or with jq +git commit -m "v$(jq -r '.version' package.json)" + +# 3. Create a tag based on the current version, either manually or with `jq`: +git tag "v$(jq -r '.version' package.json)" + +# 4. Push files, then publish +git push +npm publish +``` diff --git a/package.json b/package.json index 456e3c06..d7925b18 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "build:lib": "rollup -c", "format": "prettier --write \"./**/*.{svelte,js,md}\"", "prepack": "yarn build:docs & yarn build:lib", - "release": "standard-version" + "release": "standard-version && yarn prepack" }, "dependencies": { "flatpickr": "4.6.9" @@ -43,6 +43,11 @@ "svelte-check": "^2.8.1", "typescript": "^4.7.4" }, + "standard-version": { + "skip": { + "commit": true + } + }, "prettier": { "svelteStrictMode": true }, diff --git a/types/Breakpoint/breakpointObserver.d.ts b/types/Breakpoint/breakpointObserver.d.ts index 70ec9894..69175629 100644 --- a/types/Breakpoint/breakpointObserver.d.ts +++ b/types/Breakpoint/breakpointObserver.d.ts @@ -1,28 +1,28 @@ -import type { Readable, Subscriber, Unsubscriber } from "svelte/store"; -import type { BreakpointSize, BreakpointValue } from "./breakpoints"; - -/** - * Creates a readable store that returns the current breakpoint size. - * It also provides functions for creating derived stores used to do comparisons. - */ -export function breakpointObserver(): { - subscribe: ( - this: void, - run: Subscriber, - invalidate?: (value?: any) => void - ) => Unsubscriber; - /** - * Returns a store readable store that returns whether the current - * breakpoint is smaller than {@link size}. - * @param {BreakpointSize} size Size to compare against. - */ - smallerThan: (size: BreakpointSize) => Readable; - /** - * Returns a store readable store that returns whether the current - * breakpoint is larger than {@link size}. - * @param {BreakpointSize} size Size to compare against. - */ - largerThan: (size: BreakpointSize) => Readable; -}; - -export default breakpointObserver; +import type { Readable, Subscriber, Unsubscriber } from "svelte/store"; +import type { BreakpointSize, BreakpointValue } from "./breakpoints"; + +/** + * Creates a readable store that returns the current breakpoint size. + * It also provides functions for creating derived stores used to do comparisons. + */ +export function breakpointObserver(): { + subscribe: ( + this: void, + run: Subscriber, + invalidate?: (value?: any) => void + ) => Unsubscriber; + /** + * Returns a store readable store that returns whether the current + * breakpoint is smaller than {@link size}. + * @param {BreakpointSize} size Size to compare against. + */ + smallerThan: (size: BreakpointSize) => Readable; + /** + * Returns a store readable store that returns whether the current + * breakpoint is larger than {@link size}. + * @param {BreakpointSize} size Size to compare against. + */ + largerThan: (size: BreakpointSize) => Readable; +}; + +export default breakpointObserver; diff --git a/types/Breakpoint/breakpoints.d.ts b/types/Breakpoint/breakpoints.d.ts index 0f89df39..44bbbcc4 100644 --- a/types/Breakpoint/breakpoints.d.ts +++ b/types/Breakpoint/breakpoints.d.ts @@ -1,11 +1,11 @@ -/** - * Pixel sizes of Carbon grid breakpoints. - * @type {Record} - */ -export const breakpoints: Record; - -export type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max"; - -export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584; - -export default breakpoints; +/** + * Pixel sizes of Carbon grid breakpoints. + * @type {Record} + */ +export const breakpoints: Record; + +export type BreakpointSize = "sm" | "md" | "lg" | "xlg" | "max"; + +export type BreakpointValue = 320 | 672 | 1056 | 1312 | 1584; + +export default breakpoints; diff --git a/types/Breakpoint/index.d.ts b/types/Breakpoint/index.d.ts index e9046700..749b78c5 100644 --- a/types/Breakpoint/index.d.ts +++ b/types/Breakpoint/index.d.ts @@ -1,3 +1,3 @@ -export { default as Breakpoint } from "./Breakpoint.svelte"; -export { breakpointObserver } from "./breakpointObserver"; -export { breakpoints } from "./breakpoints"; +export { default as Breakpoint } from "./Breakpoint.svelte"; +export { breakpointObserver } from "./breakpointObserver"; +export { breakpoints } from "./breakpoints";