docs and deps update

Author: sastan

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][mozilla coc].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][faq]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[mozilla coc]: https://github.com/mozilla/diversity
+[faq]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -1,4 +1,93 @@
-# Contributing
+# Contributing to Twind
+
+Thanks for checking out Twind! Please read on to learn how you can help make this project even better.
+
+## Ways to help
+
+Regardless of your experience level, there are ways that you can help:
+
+- Share the project on Twitter
+- Star the project on Github
+- Tell your friends/co-workers about Twind
+- Write an article about Twind on Medium, Dev, or your platform of choice
+- Create written or video tutorials about Twind
+- Report bugs or provide feedback by [creating issues](https://github.com/tw-in-js/twind)
+- Contribute to the source code by fixing bugs/issues or helping us build new features
+
+## Ideas
+
+If you think anything here sounds like a good idea and/or would like to make it happen, please [file an issue](https://github.com/tw-in-js/twind) and let us know!
+
+## How to create a good bug report
+
+To be able to fix issues we need to see them on our machine. This is only possible when we can reproduce the error. The easiest way to do that is narrow down the problem to specific components or combination of them. This can be done by removing as much unrelated code as possible.
+
+The perfect way to do that is to make a [codesandbox](https://codesandbox.io/). That way you can easily share the problematic code and ensure that others can see the same issue you are seeing.
+
+For us a [codesandbox](https://codesandbox.io/) says more than a 1000 words :tada:
+
+## Local development
+
+The Twind repo is a monorepo using pnpm workspaces. The package manager used to install and link dependencies must be [pnpm](https://pnpm.io/).
+
+To develop and test a `twind` package:
+
+1. Run `pnpm install` in `twind`'s root folder
+
+2. Run `pnpm test` to run all tests
+
+<details>
+
+<summary>We recommend installing <a href="https://github.com/antfu/ni" rel="external">ni</a> to help switching between repos using different package managers.</summary>
+
+`ni` also provides the handy `nr` command which running npm scripts easier:
+
+- `ni` is equivalent to `pnpm install`
+- `nr test` is equivalent to `pnpm run test`
+
+</details>
+
+### Testing Twind against external packages
+
+You may wish to test your locally-modified copy of Twind against another package that is using it. For pnpm, after building Twind, you can use [`pnpm.overrides`](https://pnpm.io/package_json#pnpmoverrides). Please note that `pnpm.overrides` must be specified in the root `package.json` and you must first list the package as a dependency in the root `package.json`:
+
+```json
+{
+  "dependencies": {
+    "twind": "*"
+  },
+  "pnpm": {
+    "overrides": {
+      "twind": "link:../path/to/twind/packages/twind"
+    }
+  }
+}
+```
+
+And re-run `pnpm install` to link the package.
+
+## Pull Request Guidelines
+
+- Checkout a topic branch from a base branch, e.g. `main`, and merge back against that branch.
+
+- If adding a new feature:
+
+  - Add accompanying test case.
+  - Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
+
+- If fixing bug:
+
+  - If you are resolving a special issue, add `(fix #xxxx[,#xxxx])` (#xxxx is the issue id) in your PR title for a better release log, e.g. `fix: update entities encoding/decoding (fix #3899)`.
+  - Provide a detailed description of the bug in the PR. Live demo preferred.
+  - Add appropriate test coverage if applicable.
+
+- It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.
+
+- Make sure tests pass!
+
+- Commit messages must follow the [commit message convention](./.github/commit-convention.md) so that changelogs can be automatically generated.
+
+## TODO
 
 - how to contribute
 - issues: templates on stackplitz, codesandbox, ...

package.json

@@ -25,9 +25,9 @@
     "format": "prettier --write --ignore-path .gitignore . '!pnpm-lock.yaml'",
     "check": "eslint --ext .js,.jsx,.cjs,.mjs,.ts,.tsx --ignore-path .gitignore .",
     "check:fix": "npm run check -- --fix",
-    "test": "vitest --reporter dot",
+    "test": "vitest",
     "test:ui": "npm test -- --open",
-    "test:coverage": "npm test -- --coverage",
+    "test:coverage": "vitest run --coverage",
     "preinstall": "npx only-allow pnpm",
     "prepare": "husky install"
   },
@@ -36,22 +36,23 @@
     "@changesets/get-github-info": "^0.5.0",
     "@size-limit/esbuild": "^7.0.5",
     "@size-limit/file": "^7.0.5",
-    "@typescript-eslint/eslint-plugin": "^5.9.0",
-    "@typescript-eslint/parser": "^5.9.0",
-    "@vitest/ui": "^0.0.134",
+    "@typescript-eslint/eslint-plugin": "^5.9.1",
+    "@typescript-eslint/parser": "^5.9.1",
+    "@vitest/ui": "^0.0.139",
+    "c8": "^7.11.0",
     "distilt": "^0.12.0",
     "dotenv": "^10.0.0",
     "eslint": "^8.6.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.4",
-    "lint-staged": "^12.1.5",
+    "lint-staged": "^12.1.7",
     "only-allow": "^1.0.0",
     "prettier": "^2.5.1",
     "size-limit": "^7.0.5",
     "tslib": "^2.3.1",
     "typescript": "^4.5.4",
-    "vitest": "^0.0.134"
+    "vitest": "^0.0.139"
   },
   "prettier": {
     "printWidth": 100,
@@ -100,7 +101,10 @@
     ]
   },
   "lint-staged": {
-    "*.{js,jsx,cjs,mjs,ts,tsx}": "eslint --cache --fix",
+    "*.{js,jsx,cjs,mjs,ts,tsx}": [
+      "eslint --cache --fix",
+      "vitest related --run --silent"
+    ],
     "!(pnpm-lock.yaml)*": "prettier --ignore-unknown --write"
   }
 }

packages/preset-autoprefix/package.json

@@ -69,7 +69,7 @@
     }
   },
   "devDependencies": {
-    "@twind/core": "1.0.0-next.5"
+    "@twind/core": "workspace:1.0.0-next.5"
   },
   "scripts": {
     "build": "distilt",

packages/preset-mini/package.json

@@ -62,8 +62,8 @@
     }
   },
   "devDependencies": {
-    "@twind/core": "1.0.0-next.5",
-    "@twind/preset-tailwind": "1.0.0-next.5"
+    "@twind/core": "workspace:1.0.0-next.5",
+    "@twind/preset-tailwind": "workspace:1.0.0-next.5"
   },
   "scripts": {
     "build": "distilt",

packages/preset-tailwind/package.json

@@ -51,7 +51,7 @@
     }
   },
   "devDependencies": {
-    "@twind/core": "1.0.0-next.5"
+    "@twind/core": "workspace:1.0.0-next.5"
   },
   "scripts": {
     "build": "distilt",

packages/runtime/package.json

@@ -60,7 +60,7 @@
     }
   },
   "devDependencies": {
-    "@twind/core": "1.0.0-next.5"
+    "@twind/core": "workspace:1.0.0-next.5"
   },
   "scripts": {
     "build": "distilt",

packages/twind/package.json

@@ -91,11 +91,11 @@
     "@twind/preset-tailwind"
   ],
   "dependencies": {
-    "@twind/core": "1.0.0-next.5",
-    "@twind/runtime": "1.0.0-next.5",
-    "@twind/preset-autoprefix": "1.0.0-next.5",
-    "@twind/preset-mini": "1.0.0-next.5",
-    "@twind/preset-tailwind": "1.0.0-next.5"
+    "@twind/core": "workspace:1.0.0-next.5",
+    "@twind/preset-autoprefix": "workspace:1.0.0-next.5",
+    "@twind/preset-mini": "workspace:1.0.0-next.5",
+    "@twind/preset-tailwind": "workspace:1.0.0-next.5",
+    "@twind/runtime": "workspace:1.0.0-next.5"
   },
   "peerDependencies": {
     "typescript": "^4.4.0"