@xperimntl/eslint-plugin-vue-threejs 1.1.0

package/README.md

@@ -0,0 +1,82 @@
+# @xperimntl/eslint-plugin-vue-threejs
+
+[![Version](https://img.shields.io/npm/v/@xperimntl/eslint-plugin-vue-threejs?style=flat&colorA=000000&colorB=000000)](https://npmjs.com/package/@xperimntl/eslint-plugin-vue-threejs)
+[![Twitter](https://img.shields.io/twitter/follow/pmndrs?label=%40pmndrs&style=flat&colorA=000000&colorB=000000&logo=twitter&logoColor=000000)](https://twitter.com/pmndrs)
+[![Discord](https://img.shields.io/discord/740090768164651008?style=flat&colorA=000000&colorB=000000&label=discord&logo=discord&logoColor=000000)](https://discord.gg/ZZjjNvJ)
+[![Open Collective](https://img.shields.io/opencollective/all/vue-three-fiber?style=flat&colorA=000000&colorB=000000)](https://opencollective.com/vue-three-fiber)
+[![ETH](https://img.shields.io/badge/ETH-f5f5f5?style=flat&colorA=000000&colorB=000000)](https://blockchain.com/eth/address/0x6E3f79Ea1d0dcedeb33D3fC6c34d2B1f156F2682)
+[![BTC](https://img.shields.io/badge/BTC-f5f5f5?style=flat&colorA=000000&colorB=000000)](https://blockchain.com/btc/address/36fuguTPxGCNnYZSRdgdh6Ea94brCAjMbH)
+
+An ESLint plugin which provides lint rules for [@xperimntl/vue-threejs](https://github.com/chris-xperimntl/vue-threejs).
+
+## Installation
+
+```bash
+npm install @xperimntl/eslint-plugin-vue-threejs --save-dev
+```
+
+## Configuration
+
+Use the recommended [config](#recommended) to get reasonable defaults:
+
+```json
+"extends": [
+  "plugin:@xperimntl/vue-threejs/recommended"
+]
+```
+
+If you do not use a config you will need to specify individual rules and add extra configuration.
+
+Add "@xperimntl/vue-three" to the plugins section.
+
+```json
+"plugins": [
+  "@xperimntl/vue-three"
+]
+```
+
+Enable the rules that you would like to use.
+
+```json
+"rules": {
+  "@xperimntl/vue-threejs/no-clone-in-frame-loop": "error"
+}
+```
+
+## Rules
+
+✅ Enabled in the `recommended` [configuration](#recommended).<br>
+🔧 Automatically fixable by the `--fix` [CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).<br>
+💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+
+<!-- START_RULE_CODEGEN -->
+<!-- @command yarn codegen:eslint -->
+
+| Rule                                                            | Description                                                                                | ✅  | 🔧  | 💡  |
+| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | --- | --- | --- |
+| <a href="./docs/rules/no-clone-in-loop.md">no-clone-in-loop</a> | Disallow cloning vectors in the frame loop which can cause performance problems.           | ✅  |     |     |
+| <a href="./docs/rules/no-new-in-loop.md">no-new-in-loop</a>     | Disallow instantiating new objects in the frame loop which can cause performance problems. | ✅  |     |     |
+
+<!-- END_CODEGEN -->
+
+## Shareable configs
+
+### Recommended
+
+This plugin exports a `recommended` configuration that enforces rules appropriate for everyone using Vue Three Fiber.
+
+```json
+"extends": [
+  "plugin:@xperimntl/vue-threejs/recommended"
+]
+```
+
+### All
+
+This plugin also exports an `all` configuration that includes every available rule.
+
+```json
+"extends": [
+  "plugin:@xperimntl/vue-threejs/all"
+]
+```

package/dist/xperimntl-eslint-plugin-vue-threejs.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "../src/index.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoieHBlcmltbnRsLWVzbGludC1wbHVnaW4tdnVlLXRocmVlanMuY2pzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEifQ==

package/dist/xperimntl-eslint-plugin-vue-threejs.cjs.js

@@ -0,0 +1,16 @@
+"use strict";
+// this file might look strange and you might be wondering what it's for
+// it's lets you import your source files by importing this entrypoint
+// as you would import it if it was built with preconstruct build
+// this file is slightly different to some others though
+// it has a require hook which compiles your code with Babel
+// this means that you don't have to set up @babel/register or anything like that
+// but you can still require this module and it'll be compiled
+
+// this bit of code imports the require hook and registers it
+let unregister = require("../../../node_modules/@preconstruct/hook").___internalHook(typeof __dirname === 'undefined' ? undefined : __dirname, "../../..", "..");
+
+// this re-exports the source file
+module.exports = require("../src/index.ts");
+
+unregister();

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@xperimntl/eslint-plugin-vue-threejs",
+  "version": "1.1.0",
+  "description": "ESLint rules for @xperimntl/vue-threejs.",
+  "keywords": [
+    "vue",
+    "renderer",
+    "fiber",
+    "three",
+    "threejs",
+    "eslint"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/chris-xperimntl/vue-threejs/issues"
+  },
+  "homepage": "https://github.com/chris-xperimntl/vue-threejs/tree/master/packages/eslint-plugin#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/chris-xperimntl/vue-threejs.git"
+  },
+  "main": "dist/xperimntl-eslint-plugin-vue-threejs.cjs.js",
+  "module": "dist/xperimntl-eslint-plugin-vue-threejs.esm.js",
+  "types": "dist/xperimntl-eslint-plugin-vue-threejs.cjs.d.ts",
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "preconstruct": {
+    "entrypoints": [
+      "index.ts"
+    ]
+  },
+  "dependencies": {
+    "@babel/runtime": "^7.29.2",
+    "eslint": "^8.12.0"
+  },
+  "devDependencies": {
+    "@types/eslint": "^8.4.10",
+    "@types/lodash": "^4.17.24",
+    "lodash": "^4.17.19",
+    "prettier": "^2.6.1",
+    "ts-node": "^10.9.1"
+  },
+  "scripts": {
+    "codegen": "ts-node scripts/codegen.ts"
+  }
+}