v0.9.0 (#18)

- Bring back main module imports.

- Refactor the repo structure into a monorepo where the lib, docs and tests are separate packages, for better isolation.
Update names of package.json scripts.

- Bring in ESLint for enforcing better code quality (also to sort imports).

- Add new Draggable option/setting: sensorProcessingMode. It can be sampled (default) or immediate. Check the docs for more in-depth explanation.

- Ensure the ticker can never accidentally tick on the server.

- Update docs and deps.

- BREAKING: In default sensorProcessingMode (sampled), if you previously had a sensor emitting end event before the draggable's drag start process was started/finished, the start procedure was discarded, which also meant that the start events/callbacks were never called. To me, this was a bit problematic, that an end event can be sent without a start event firing first (or at all). So now this is behavior is changed so that the start procedure is forcefully completed if it has not yet completed when the drag stops for one reason or another.

- BREAKING: Rename Draggable group option/setting to dndGroups and enforce it to always be a Set of DraggableDndGroups. This makes the Droppable and Draggable matching quite a bit more flexible.

- BREAKING: Droppable accept option/setting can not be an array anymore, but a Set instead. It can still be a function too though, like before.

Author: niklasramo

.github/workflows/deploy-docs.yml

@@ -14,9 +14,9 @@ jobs:
           cache: npm
       - run: npm ci
       - name: Build docs
-        run: npm run docs-build
+        run: npm run docs:build
       - name: Deploy docs
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/.vitepress/dist
+          publish_dir: packages/dragdoll-docs/docs/.vitepress/dist

.github/workflows/publish-npm.yml

@@ -12,6 +12,7 @@ jobs:
           node-version: '20.x'
           registry-url: 'https://registry.npmjs.org'
       - run: npm ci
-      - run: npm publish
+      - run: npm run build
+      - run: npm publish --workspace=dragdoll
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/run-tests.yml

@@ -18,10 +18,12 @@ jobs:
           node-version: '20.x'
       - name: Install dependencies
         run: npm ci
+      - name: Build
+        run: npm run build
       - name: Lint
         run: npm run lint
-      - name: Tests
+      - name: Test
         env:
           BROWSERSTACK_USERNAME: ${{ secrets.BROWSERSTACK_USERNAME }}
           BROWSERSTACK_ACCESS_KEY: ${{ secrets.BROWSERSTACK_ACCESS_KEY }}
-        run: npm run test
+        run: npm run test:browserstack

.gitignore

@@ -1,8 +1,6 @@
 node_modules
-docs/.vitepress/cache
-docs/.vitepress/dist
+cache
 *.log
 *.env
 *.DS_Store
-.parcel-cache
 .cursorrules

.prettierignore

@@ -1,15 +1,8 @@
-**/*.log
-**/*.map
-**/*.svg
-**/*.png
 **/.env
 **/.git
 **/.gitignore
-**/.parcel-cache
 **/.prettierignore
-**/.cursorrules
 **/cache
 **/dist
-**/docs/public/examples
 **/node_modules
 **/package-lock.json

CONTRIBUTING.md

@@ -15,24 +15,24 @@ Please [create an issue](https://github.com/niklasramo/dragdoll/issues/new) and
    - [Fork DragDoll](https://github.com/niklasramo/dragdoll#fork-destination-box).
    - Create a new branch for your pull request from the master branch. The name of the pull request branch should start with the id of the issue you opened for the pull request, e.g. `#123-fix-something`.
 3. **Setup the development environment.**
-   - Run `npm ci` in the root.
-   - You can now run the following commands:
+   - Run `npm ci` in the root to install dependencies for all workspaces.
+   - You can now run the following commands in the _root_:
      - `npm run build`
-       - Builds the distributable files from `src` directory into the `dist` directory.
+       - Builds the library (`dragdoll`), test suite (`dragdoll-tests`), and docs examples (`dragdoll-docs`), in that order.
      - `npm run format`
-       - Formats all files in `src` directory with Prettier.
+       - Formats all files in all workspaces with Prettier.
      - `npm run lint`
-       - Lints all files in `src` directory with Prettier and validates TS types.
-     - `npm run test`
-       - Runs unit tests in Browserstack.
+       - Lints all files in all workspaces with Prettier and validates TS types.
+     - `npm run test:browserstack`
+       - Runs tests (from `dragdoll-tests`) in Browserstack.
        - To make this work you need to create an `.env` file the project root, which should contain `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` variables.
-     - `npm run test-local`
-       - Runs unit tests locally in Chrome and Firefox. You have to have them both installed.
+     - `npm run test:local`
+       - Runs tests (from `dragdoll-tests`) locally in Chrome and Firefox. You have to have them both installed.
 4. **Do the updates.**
    - Remember scope. Don't refactor things that are not related to the pull request.
-   - After you're done update unit tests and docs (`README.md`) if necessary.
+   - After you're done update tests (`dragdoll-tests`) and docs (`dragdoll-docs`) if necessary.
 5. **Build and test changes.**
-   - Run `npm run build` to build the lib with the changes and then run `npm run test` (or `npm run test-local`) to make sure the changes didn't cause regressions.
+   - Run `npm run build` to build the lib after the changes and then run `npm run test:browserstack` (or `npm run test:local`) to make sure the changes didn't cause regressions.
 6. **Create the pull request.**
    - Do your best to explain what the pull request fixes.
    - Mention which issue(s) will be closed by the pull request, e.g. `Closes #123`.

README.md

@@ -36,6 +36,13 @@ No frameworks were abused while writing this library. It's all vanilla framework
 
 https://niklasramo.github.io/dragdoll/
 
+## Repo structure
+
+- [`dragdoll-root`](./) - Root package.
+- [`packages/dragdoll`](./packages/dragdoll) - The core dragdoll package.
+- [`packages/dragdoll-docs`](./packages/dragdoll-docs) - Docs for the dragdoll package.
+- [`packages/dragdoll-tests`](./packages/dragdoll-tests) - Tests for the dragdoll package.
+
 ## Copyright
 
 Copyright © 2022-2024, Niklas Rämö (inramo@gmail.com). Licensed under the [MIT license](/LICENSE.md).