diff --git a/.changeset/silly-foxes-melt.md b/.changeset/silly-foxes-melt.md new file mode 100644 index 0000000..883068f --- /dev/null +++ b/.changeset/silly-foxes-melt.md @@ -0,0 +1,7 @@ +--- +"@sv443-network/userutils": major +--- + +**BREAKING:** Moved a majority of the general-purpose code to `@sv443-network/coreutils` +The features are still available in the same way, but some of them needed to be modified so they were more generic and consistent with the new package's codebase. +TODO: list changes diff --git a/.changeset/ten-otters-check.md b/.changeset/ten-otters-check.md new file mode 100644 index 0000000..2a5665d --- /dev/null +++ b/.changeset/ten-otters-check.md @@ -0,0 +1,5 @@ +--- +"@sv443-network/userutils": major +--- + +Increased library target to ES2018 diff --git a/.github/workflows/build-and-publish-jsr.yml b/.github/workflows/build-and-publish-jsr.yml index ae56a40..6456731 100644 --- a/.github/workflows/build-and-publish-jsr.yml +++ b/.github/workflows/build-and-publish-jsr.yml @@ -21,7 +21,7 @@ jobs: env: CI: "true" STORE_PATH: "" - PNPM_VERSION: 9 + PNPM_VERSION: 10 RETENTION_DAYS: 2 steps: diff --git a/.github/workflows/build-and-publish-npm.yml b/.github/workflows/build-and-publish-npm.yml index 8b80d92..2c2079e 100644 --- a/.github/workflows/build-and-publish-npm.yml +++ b/.github/workflows/build-and-publish-npm.yml @@ -27,7 +27,7 @@ jobs: env: CI: "true" STORE_PATH: "" - PNPM_VERSION: 9 + PNPM_VERSION: 10 RETENTION_DAYS: 2 steps: diff --git a/.github/workflows/lint-and-test-code.yml b/.github/workflows/lint-and-test-code.yml index 3d5a96d..c5287c5 100644 --- a/.github/workflows/lint-and-test-code.yml +++ b/.github/workflows/lint-and-test-code.yml @@ -19,7 +19,7 @@ jobs: env: CI: "true" STORE_PATH: "" - PNPM_VERSION: 9 + PNPM_VERSION: 10 RETENTION_DAYS: 2 steps: diff --git a/LICENSE.txt b/LICENSE.txt index d613d26..ee2b85c 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Sven Fehler (Sv443) +Copyright (c) 2023 Sv443 Network and Sven Fehler (Sv443) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README-summary.md b/README-summary.md index 7125897..7c89b95 100644 --- a/README-summary.md +++ b/README-summary.md @@ -171,6 +171,7 @@ Shameless plug: I made a [template for userscripts in TypeScript](https://github
- Then, access the functions on the global variable `UserUtils`: + ```ts UserUtils.addGlobalStyle("body { background-color: red; }"); @@ -183,6 +184,7 @@ Shameless plug: I made a [template for userscripts in TypeScript](https://github
- If you're using TypeScript and it complains about the missing global variable `UserUtils`, install the library using the package manager of your choice and add the following inside any `.ts` file that is included in the final build: + ```ts declare const UserUtils: typeof import("@sv443-network/userutils"); @@ -195,7 +197,8 @@ Shameless plug: I made a [template for userscripts in TypeScript](https://github
-- If you're using a linter like ESLint, it might complain about the global variable `UserUtils` not being defined. To fix this, add the following to your ESLint configuration file: +- If you're using a linter like ESLint, it might complain about the global variable `UserUtils` not being defined. To fix this, add the following to your ESLint configuration file: + ```json "globals": { "UserUtils": "readonly" diff --git a/README.md b/README.md index 6564216..a8e67f5 100644 --- a/README.md +++ b/README.md @@ -199,7 +199,8 @@ Shameless plug: I made a [template for userscripts in TypeScript](https://github
-- If you're using a linter like ESLint, it might complain about the global variable `UserUtils` not being defined. To fix this, add the following to your ESLint configuration file: +- If you're using a linter like ESLint, it might complain about the global variable `UserUtils` not being defined. To fix this, add the following to your ESLint configuration file: + ```json "globals": { "UserUtils": "readonly" diff --git a/docs.md b/docs.md index 5389476..348121a 100644 --- a/docs.md +++ b/docs.md @@ -1,12 +1,18 @@ # UserUtils Documentation +General purpose DOM/GreaseMonkey library that allows you to register listeners for when CSS selectors exist, intercept events, create persistent & synchronous data stores, modify the DOM more easily and much more. +Contains builtin TypeScript declarations. Supports ESM and CJS imports via a bundler and global declaration via `@require` or `