From f4330ce946a22301250c38c6eb1f6fa157873fa4 Mon Sep 17 00:00:00 2001 From: Simon Reinisch Date: Sat, 18 Jan 2025 16:52:30 +0100 Subject: [PATCH] chore: rename repository and update contributing guidelines --- .github/CONTRIBUTING.md | 27 +++++++++++++++++++-------- .github/ISSUE_TEMPLATE/question.md | 2 +- README.md | 7 +++---- docs/pages/faq.md | 2 +- packages/preact/README.md | 8 ++++---- packages/preact/package.json | 6 +++--- packages/preact/vite.config.mts | 2 +- packages/react/README.md | 8 ++++---- packages/react/package.json | 6 +++--- packages/react/vite.config.mts | 2 +- packages/vanilla/README.md | 6 +++--- packages/vanilla/package.json | 6 +++--- packages/vanilla/recipes.md | 10 +++++----- packages/vanilla/vite.config.mts | 2 +- packages/vue/README.md | 8 ++++---- packages/vue/package.json | 6 +++--- packages/vue/vite.config.mts | 2 +- 17 files changed, 60 insertions(+), 50 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 8d8e170..84c3eb0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,23 +2,34 @@ ### Issue -1. Make sure you're using the latest version, check [releases](https://github.com/Simonwep/selection/releases/tag/2.1.2) for that. -2. [Use the search](https://github.com/Simonwep/selection/search?type=Issues), maybe there is already an answer. -3. If not found, [create an issue](https://github.com/Simonwep/selection/issues/new), please dont forget to carefully describe it how to reproduce it / pay attention to the issue-template. +* Make sure you're using the latest version, check [releases](https://github.com/simonwep/viselect/releases/tag/2.1.2) for that. +* [Use the search](https://github.com/simonwep/viselect/search?type=Issues), maybe there is already an answer. +* If not found, [create an issue](https://github.com/simonwep/viselect/issues/new), please don't forget to carefully describe it how to reproduce it / pay attention to the issue-template. *** ### Pull Request -1. Pull requests only into the [master](https://github.com/Simonwep/selection/tree/master) branch. +* Pull requests only into the [master](https://github.com/simonwep/viselect/tree/master) branch. +* Make sure to use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/): + - `docs: ` - for changes in the documentation. + - `feat([package]): ` - for new features in the corresponding package. + - `fix([package]): ` - for bug fixes in the corresponding package. + - `refactor([package]): ` - for changes in the code that neither fixes a bug nor adds a feature. + - `chore: ` - for changes in the build process or auxiliary tools. *** -#### Setup +### Working on the library This project requires [pnpm](https://pnpm.io) and [node](https://nodejs.org/en/). - -1. Fork this repo on [GitHub](https://github.com/Simonwep/selection). + +1. Fork this repo on [GitHub](https://github.com/simonwep/viselect). 2. Check out the master locally. 3. From your local repro run `pnpm install`. -4. Run `pnpm start dev`. +4. Run `pnpm start dev` to start a dev server for all packages. + +#### Working on the docs + +This project uses [vitepress](https://vitepress.dev/) for the documentation. +Use the `docs:` commands to work on the documentation. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index 1491518..246e917 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -7,4 +7,4 @@ assignees: '' --- -**Use [discussions](https://github.com/Simonwep/selection/discussions).** +**Use [discussions](https://github.com/simonwep/viselect/discussions).** diff --git a/README.md b/README.md index 0b75809..3e1867c 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,13 @@ Support me - version + version Buy me a coffee - Build Status + src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"> gzip size brotli size Buy me a coffee - Build Status + src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"> gzip size brotli size > [!NOTE] -> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/selection/tree/master/packages/vanilla). +> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/viselect/tree/master/packages/vanilla). > The core API is fairly simple, if you want to have full control over it, you should roll out your own wrapper in your app. ### Installation @@ -68,7 +68,7 @@ Last but not least, you'll need to add some basic styles to make your selection- ``` Additionally, to not interfere with text-selection, selection-js won't prevent any default events anymore (as of `v2.0.3`). -This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/Simonwep/selection/pull/99), reported in [#103](https://github.com/Simonwep/selection/issues/103)). +This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/simonwep/viselect/pull/99), reported in [#103](https://github.com/simonwep/viselect/issues/103)). If you don't care about text-selection, add the following to the container where all your selectables are located: ```css diff --git a/packages/preact/package.json b/packages/preact/package.json index 225829c..431e62d 100644 --- a/packages/preact/package.json +++ b/packages/preact/package.json @@ -3,9 +3,9 @@ "version": "3.9.0", "description": "Preact wrapper around the viselect vanilla library", "author": "Simon Reinisch ", - "bugs": "https://github.com/Simonwep/selection/issues", - "homepage": "https://github.com/Simonwep/selection#readme", - "repository": "git+https://github.com/Simonwep/selection.git", + "bugs": "https://github.com/simonwep/viselect/issues", + "homepage": "https://github.com/simonwep/viselect#readme", + "repository": "git+https://github.com/simonwep/viselect.git", "license": "MIT", "main": "./dist/viselect.umd.js", "module": "./dist/viselect.mjs", diff --git a/packages/preact/vite.config.mts b/packages/preact/vite.config.mts index c97602e..01de2f5 100644 --- a/packages/preact/vite.config.mts +++ b/packages/preact/vite.config.mts @@ -4,7 +4,7 @@ import banner from 'vite-plugin-banner'; import dts from 'vite-plugin-dts'; import {version} from './package.json'; -const header = `/*! @viselect/preact v${version} MIT | https://github.com/Simonwep/selection/tree/master/packages/preact */`; +const header = `/*! @viselect/preact v${version} MIT | https://github.com/simonwep/viselect/tree/master/packages/preact */`; export default defineConfig(env => ({ root: env.mode === 'production' ? '.' : './demo', diff --git a/packages/react/README.md b/packages/react/README.md index 1d7d283..cbbeac6 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -18,9 +18,9 @@ Buy me a coffee - Build Status + src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"> gzip size brotli size > [!NOTE] -> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/selection/tree/master/packages/vanilla). +> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/viselect/tree/master/packages/vanilla). > The core API is fairly simple, if you want to have full control over it, you should roll out your own wrapper in your app. ### Installation @@ -71,7 +71,7 @@ Last but not least, you'll need to add some basic styles to make your selection- ``` Additionally, to not interfere with text-selection, selection-js won't prevent any default events anymore (as of `v2.0.3`). -This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/Simonwep/selection/pull/99), reported in [#103](https://github.com/Simonwep/selection/issues/103)). +This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/simonwep/viselect/pull/99), reported in [#103](https://github.com/simonwep/viselect/issues/103)). If you don't care about text-selection, add the following to the container where all your selectables are located: ```css diff --git a/packages/react/package.json b/packages/react/package.json index f4a09e5..e15a456 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -3,9 +3,9 @@ "version": "3.9.0", "description": "React wrapper around the viselect vanilla library", "author": "Simon Reinisch ", - "bugs": "https://github.com/Simonwep/selection/issues", - "homepage": "https://github.com/Simonwep/selection#readme", - "repository": "git+https://github.com/Simonwep/selection.git", + "bugs": "https://github.com/simonwep/viselect/issues", + "homepage": "https://github.com/simonwep/viselect#readme", + "repository": "git+https://github.com/simonwep/viselect.git", "license": "MIT", "main": "./dist/viselect.umd.js", "module": "./dist/viselect.mjs", diff --git a/packages/react/vite.config.mts b/packages/react/vite.config.mts index 6371e61..05680f5 100644 --- a/packages/react/vite.config.mts +++ b/packages/react/vite.config.mts @@ -4,7 +4,7 @@ import banner from 'vite-plugin-banner'; import dts from 'vite-plugin-dts'; import {version} from './package.json'; -const header = `/*! @viselect/react v${version} MIT | https://github.com/Simonwep/selection/tree/master/packages/react */`; +const header = `/*! @viselect/react v${version} MIT | https://github.com/simonwep/viselect/tree/master/packages/react */`; export default defineConfig(env => ({ root: env.mode === 'production' ? '.' : './demo', diff --git a/packages/vanilla/README.md b/packages/vanilla/README.md index 65b8a86..d9606c5 100644 --- a/packages/vanilla/README.md +++ b/packages/vanilla/README.md @@ -18,9 +18,9 @@ Buy me a coffee - Build Status + src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"> gzip size brotli size ", - "bugs": "https://github.com/Simonwep/selection/issues", - "homepage": "https://github.com/Simonwep/selection#readme", - "repository": "git+https://github.com/Simonwep/selection.git", + "bugs": "https://github.com/simonwep/viselect/issues", + "homepage": "https://github.com/simonwep/viselect#readme", + "repository": "git+https://github.com/simonwep/viselect.git", "license": "MIT", "main": "./dist/viselect.umd.js", "module": "./dist/viselect.mjs", diff --git a/packages/vanilla/recipes.md b/packages/vanilla/recipes.md index 10d60d8..c0fb703 100644 --- a/packages/vanilla/recipes.md +++ b/packages/vanilla/recipes.md @@ -1,6 +1,6 @@ ### Requested features - immediately brought to life by a bit of code -#### Allowing the user to scroll with two fingers ([#70](https://github.com/Simonwep/selection/issues/70)) +#### Allowing the user to scroll with two fingers ([#70](https://github.com/simonwep/viselect/issues/70)) ```js selection.on('beforestart', (() => { @@ -31,7 +31,7 @@ selection.on('beforestart', (() => { })()); ``` -#### Preventing the start of a selection based on certain conditions ([#73](https://github.com/Simonwep/selection/issues/73)) +#### Preventing the start of a selection based on certain conditions ([#73](https://github.com/simonwep/viselect/issues/73)) ```js selection.on('beforestart', ({event}) => { @@ -48,7 +48,7 @@ selection.on('beforestart', ({event}) => { }); ``` -#### Preventing select from right click, middle mouse or left click ([#101](https://github.com/Simonwep/selection/issues/101)) +#### Preventing select from right click, middle mouse or left click ([#101](https://github.com/simonwep/viselect/issues/101)) ```js selection.on('beforestart', (event) => { const allowedButtons = [ @@ -62,8 +62,8 @@ selection.on('beforestart', (event) => { }); ``` -> Feel free to submit a [PR](https://github.com/Simonwep/selection/compare) or create -> an [issue](https://github.com/Simonwep/selection/issues/new?assignees=Simonwep&labels=&template=feature_request.md&title=) if +> Feel free to submit a [PR](https://github.com/simonwep/viselect/compare) or create +> an [issue](https://github.com/simonwep/viselect/issues/new?assignees=Simonwep&labels=&template=feature_request.md&title=) if > you got any ideas for more examples! #### Preventing text-selection diff --git a/packages/vanilla/vite.config.mts b/packages/vanilla/vite.config.mts index a8d5a96..189188e 100644 --- a/packages/vanilla/vite.config.mts +++ b/packages/vanilla/vite.config.mts @@ -3,7 +3,7 @@ import {version} from './package.json'; import banner from 'vite-plugin-banner'; import dts from 'vite-plugin-dts'; -const header = `/*! @viselect/vanilla v${version} MIT | https://github.com/Simonwep/selection/tree/master/packages/vanilla */`; +const header = `/*! @viselect/vanilla v${version} MIT | https://github.com/simonwep/viselect/tree/master/packages/vanilla */`; export default defineConfig(env => ({ root: env.mode === 'production' ? '.' : './demo', diff --git a/packages/vue/README.md b/packages/vue/README.md index 3b0994f..f971e27 100644 --- a/packages/vue/README.md +++ b/packages/vue/README.md @@ -18,9 +18,9 @@ Buy me a coffee - Build Status + src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"> gzip size brotli size > [!NOTE] -> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/selection/tree/master/packages/vanilla). +> This is merely a convenience wrapper around [@viselect/vanilla](https://github.com/simonwep/viselect/tree/master/packages/vanilla). > The core API is fairly simple, if you want to have full control over it, you should roll out your own wrapper in your app. ### Installation @@ -68,7 +68,7 @@ Last but not least, you'll need to add some basic styles to make your selection- ``` Additionally, to not interfere with text-selection, selection-js won't prevent any default events anymore (as of `v2.0.3`). -This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/Simonwep/selection/pull/99), reported in [#103](https://github.com/Simonwep/selection/issues/103)). +This, however, can cause problems with the actual selection ("introduced" by [#99](https://github.com/simonwep/viselect/pull/99), reported in [#103](https://github.com/simonwep/viselect/issues/103)). If you don't care about text-selection, add the following to the container where all your selectables are located: ```css diff --git a/packages/vue/package.json b/packages/vue/package.json index 72bfc31..d278862 100644 --- a/packages/vue/package.json +++ b/packages/vue/package.json @@ -3,9 +3,9 @@ "version": "3.9.0", "description": "Simple, lightweight and modern library library for making visual DOM Selections.", "author": "Simon Reinisch ", - "bugs": "https://github.com/Simonwep/selection/issues", - "homepage": "https://github.com/Simonwep/selection#readme", - "repository": "git+https://github.com/Simonwep/selection.git", + "bugs": "https://github.com/simonwep/viselect/issues", + "homepage": "https://github.com/simonwep/viselect#readme", + "repository": "git+https://github.com/simonwep/viselect.git", "license": "MIT", "main": "./dist/viselect.umd.js", "module": "./dist/viselect.mjs", diff --git a/packages/vue/vite.config.mts b/packages/vue/vite.config.mts index 18cb961..80cd894 100644 --- a/packages/vue/vite.config.mts +++ b/packages/vue/vite.config.mts @@ -5,7 +5,7 @@ import dts from 'vite-plugin-dts'; import banner from 'vite-plugin-banner'; import {version} from './package.json'; -const header = `/*! @viselect/vue v${version} MIT | https://github.com/Simonwep/selection/tree/master/packages/vue */`; +const header = `/*! @viselect/vue v${version} MIT | https://github.com/simonwep/viselect/tree/master/packages/vue */`; export default defineConfig(env => ({ root: env.mode === 'production' ? '.' : './demo',