Skip to content

Commit

Permalink
chore: rename repository and update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
simonwep committed Jan 18, 2025
1 parent cbc1bac commit f4330ce
Show file tree
Hide file tree
Showing 17 changed files with 60 additions and 50 deletions.
27 changes: 19 additions & 8 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ assignees: ''

---

**Use [discussions](https://github.com/Simonwep/selection/discussions).**
**Use [discussions](https://github.com/simonwep/viselect/discussions).**
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
<a href="https://github.com/sponsors/Simonwep"><img
alt="Support me"
src="https://img.shields.io/badge/github-support-6a15cc.svg"></a>
<img alt="version" src="https://img.shields.io/github/lerna-json/v/Simonwep/selection?color=%233d24c9&label=version">
<img alt="version" src="https://img.shields.io/github/lerna-json/v/simonwep/viselect?color=%233d24c9&label=version">
<a href="https://www.buymeacoffee.com/aVc3krbXQ"><img
alt="Buy me a coffee"
src="https://img.shields.io/badge/%F0%9F%8D%BA-buy%20me%20a%20beer-%23FFDD00"></a>
<a href="https://github.com/Simonwep/selection/actions?query=workflow%3ACI"><img
<a href="https://github.com/simonwep/viselect/actions?query=workflow%3ACI"><img
alt="Build Status"
src="https://github.com/Simonwep/selection/workflows/CI/badge.svg"></a>
src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"></a>
<img alt="gzip size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/vanilla/dist/viselect.umd.js?compression=gzip">
<img alt="brotli size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/vanilla/dist/viselect.umd.js?compression=brotli">
<a href="https://v3.vuejs.org"><img
Expand All @@ -48,7 +48,6 @@
* 📱 Mobile / touch support
* 🖱 Vertical and horizontal scroll support
* 💪 Hardened (over 3 years old and used in many apps)
* 🖼 Support for major frameworks (WIP)

### Getting started

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ outline: deep
# Text is selected by default when dragging the mouse over text

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
Expand Down
8 changes: 4 additions & 4 deletions packages/preact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
<a href="https://www.buymeacoffee.com/aVc3krbXQ"><img
alt="Buy me a coffee"
src="https://img.shields.io/badge/%F0%9F%8D%BA-buy%20me%20a%20beer-%23FFDD00"></a>
<a href="https://github.com/Simonwep/selection/actions?query=workflow%3ACI"><img
<a href="https://github.com/simonwep/viselect/actions?query=workflow%3ACI"><img
alt="Build Status"
src="https://github.com/Simonwep/selection/workflows/CI/badge.svg"></a>
src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"></a>
<img alt="gzip size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/preact/dist/viselect.mjs?compression=gzip">
<img alt="brotli size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/preact/dist/viselect.mjs?compression=brotli">
<a href="https://v3.vuejs.org"><img
Expand All @@ -46,7 +46,7 @@
<br>

> [!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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions packages/preact/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"version": "3.9.0",
"description": "Preact wrapper around the viselect vanilla library",
"author": "Simon Reinisch <[email protected]>",
"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",
Expand Down
2 changes: 1 addition & 1 deletion packages/preact/vite.config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
8 changes: 4 additions & 4 deletions packages/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
<a href="https://www.buymeacoffee.com/aVc3krbXQ"><img
alt="Buy me a coffee"
src="https://img.shields.io/badge/%F0%9F%8D%BA-buy%20me%20a%20beer-%23FFDD00"></a>
<a href="https://github.com/Simonwep/selection/actions?query=workflow%3ACI"><img
<a href="https://github.com/simonwep/viselect/actions?query=workflow%3ACI"><img
alt="Build Status"
src="https://github.com/Simonwep/selection/workflows/CI/badge.svg"></a>
src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"></a>
<img alt="gzip size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/react/dist/viselect.mjs?compression=gzip">
<img alt="brotli size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/react/dist/viselect.mjs?compression=brotli">
<a href="https://v3.vuejs.org"><img
Expand All @@ -46,7 +46,7 @@
<br>

> [!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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions packages/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"version": "3.9.0",
"description": "React wrapper around the viselect vanilla library",
"author": "Simon Reinisch <[email protected]>",
"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",
Expand Down
2 changes: 1 addition & 1 deletion packages/react/vite.config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
6 changes: 3 additions & 3 deletions packages/vanilla/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
<a href="https://www.buymeacoffee.com/aVc3krbXQ"><img
alt="Buy me a coffee"
src="https://img.shields.io/badge/%F0%9F%8D%BA-buy%20me%20a%20beer-%23FFDD00"></a>
<a href="https://github.com/Simonwep/selection/actions?query=workflow%3ACI"><img
<a href="https://github.com/simonwep/viselect/actions?query=workflow%3ACI"><img
alt="Build Status"
src="https://github.com/Simonwep/selection/workflows/CI/badge.svg"></a>
src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"></a>
<img alt="gzip size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/vanilla/dist/viselect.mjs?compression=gzip">
<img alt="brotli size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/vanilla/dist/viselect.mjs?compression=brotli">
<a href="https://v3.vuejs.org"><img
Expand Down Expand Up @@ -81,7 +81,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
Expand Down
6 changes: 3 additions & 3 deletions packages/vanilla/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"version": "3.9.0",
"description": "Simple, lightweight and modern library library for making visual DOM Selections.",
"author": "Simon Reinisch <[email protected]>",
"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",
Expand Down
10 changes: 5 additions & 5 deletions packages/vanilla/recipes.md
Original file line number Diff line number Diff line change
@@ -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', (() => {
Expand Down Expand Up @@ -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}) => {
Expand All @@ -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 = [
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/vanilla/vite.config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down
8 changes: 4 additions & 4 deletions packages/vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
<a href="https://www.buymeacoffee.com/aVc3krbXQ"><img
alt="Buy me a coffee"
src="https://img.shields.io/badge/%F0%9F%8D%BA-buy%20me%20a%20beer-%23FFDD00"></a>
<a href="https://github.com/Simonwep/selection/actions?query=workflow%3ACI"><img
<a href="https://github.com/simonwep/viselect/actions?query=workflow%3ACI"><img
alt="Build Status"
src="https://github.com/Simonwep/selection/workflows/CI/badge.svg"></a>
src="https://github.com/simonwep/viselect/workflows/CI/badge.svg"></a>
<img alt="gzip size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/vue/dist/viselect.mjs?compression=gzip">
<img alt="brotli size" src="https://img.badgesize.io/https://cdn.jsdelivr.net/npm/@viselect/vue/dist/viselect.mjs?compression=brotli">
<a href="https://v3.vuejs.org"><img
Expand All @@ -46,7 +46,7 @@
<br>

> [!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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions packages/vue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"version": "3.9.0",
"description": "Simple, lightweight and modern library library for making visual DOM Selections.",
"author": "Simon Reinisch <[email protected]>",
"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",
Expand Down
2 changes: 1 addition & 1 deletion packages/vue/vite.config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit f4330ce

Please sign in to comment.