detective-vue2 1.0.1 → 2.0.0

package/README.md

@@ -1,23 +1,27 @@
-> Get the dependencies of Vue module
+# detective-vue2
+
+[![CI](https://img.shields.io/github/actions/workflow/status/havunen/detective-vue2/ci.yml?branch=main&label=CI&logo=github)](https://github.com/havunen/detective-vue2/actions/workflows/ci.yml?query=branch%3Amain)
+[![npm version](https://img.shields.io/npm/v/detective-vue2?logo=npm&logoColor=fff)](https://www.npmjs.com/package/detective-vue2)
+[![npm downloads](https://img.shields.io/npm/dm/detective-vue2)](https://www.npmjs.com/package/detective-vue2)
 
-Supports Vue2 and Vue3
+> Get the dependencies of Vue module
+> Supports Vue2 and Vue3
 
 ```sh
 npm install detective-vue2
 ```
-
-### Usage
+## Usage
 
 ```js
 const fs = require('fs');
 const detective = require('detective-vue2');
 
-const mySourceCode = fs.readFileSync('myfile.vue', 'utf8');
+const content = fs.readFileSync('myfile.vue', 'utf8');
 
 // Pass in a file's content or an AST
-const dependencies = detective(mySourceCode);
+const dependencies = detective(content);
 ```
 
-#### License
+## License
 
 MIT

package/index.js

@@ -1,49 +1,58 @@
 'use strict';
 
-const compiler = require('@vue/compiler-sfc')
-const detectiveTypeScript = require('detective-typescript')
-const detectiveEs6 = require('detective-es6')
-const detectiveScss = require('detective-scss')
-const detectiveStylus = require('detective-stylus')
-const detectiveSass = require('detective-sass')
+const compiler = require('@vue/compiler-sfc');
+const detectiveTypeScript = require('detective-typescript');
+const detectiveEs6 = require('detective-es6');
+const detectiveScss = require('detective-scss');
+const detectiveStylus = require('detective-stylus');
+const detectiveSass = require('detective-sass');
 
 /**
  * Extracts the dependencies of the supplied Vue module
  */
-module.exports = function vueDetective(fileContent, opts) {
-  if (typeof fileContent === 'undefined') throw new Error('content not given');
+module.exports = function(fileContent, opts) {
+  if (fileContent === undefined) throw new Error('content not given');
   if (typeof fileContent !== 'string') throw new Error('content is not a string');
 
-  const result = compiler.parse(fileContent, {sourceMap: false})
-  const styles = result.descriptor.styles;
-  const script = result.descriptor.script;
+  const result = compiler.parse(fileContent, { sourceMap: false });
+  const { styles, script } = result.descriptor;
 
   const dependencies = [];
 
-  if (script && script.content) {
-    if (script.attrs && script.attrs.lang === 'ts') {
-      dependencies.push(...detectiveTypeScript(script.content, opts))
+  if (script?.content) {
+    if (script.attrs?.lang === 'ts') {
+      dependencies.push(...detectiveTypeScript(script.content, opts));
     } else {
-      dependencies.push(...detectiveEs6(script.content, opts))
+      dependencies.push(...detectiveEs6(script.content, opts));
     }
   }
 
-  if (styles) {
-    for (let i = 0; i < styles.length; i++) {
-      const style = styles[i];
-      const styleLan = style.attrs.lang;
-
-      if (styleLan === 'scss') {
-        dependencies.push(...detectiveScss(style.content))
-      } else if (styleLan === 'stylus') {
-        dependencies.push(...detectiveStylus(style.content))
-      } else if (styleLan === 'sass') {
-        dependencies.push(...detectiveSass(style.content))
-      } else {
-        // css has no deps
+  if (!styles) return dependencies;
+
+  for (const style of styles) {
+    switch (style.attrs.lang) {
+      case 'scss': {
+        dependencies.push(...detectiveScss(style.content));
+
+        break;
+      }
+
+      case 'stylus': {
+        dependencies.push(...detectiveStylus(style.content));
+
+        break;
       }
+
+      case 'sass': {
+        dependencies.push(...detectiveSass(style.content));
+
+        break;
+      }
+
+      default:
+        // css has no deps
     }
   }
 
   return dependencies;
-}
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "detective-vue2",
-  "version": "1.0.1",
+  "version": "2.0.0",
   "author": "Havunen <sampo.kivisto@live.fi>",
   "description": "Get the dependencies of a Vue module",
   "main": "index.js",
@@ -8,9 +8,11 @@
     "index.js"
   ],
   "scripts": {
-    "lint": "eslint index.js test/test.js",
+    "lint": "xo",
+    "fix": "xo --fix",
     "mocha": "mocha",
     "test": "npm run lint && npm run mocha",
+    "test:ci": "c8 npm run mocha",
     "watch": "npm run mocha -- -w"
   },
   "repository": {
@@ -25,21 +27,62 @@
     "import",
     "vue"
   ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/havunen/detective-vue2/issues"
+  },
+  "homepage": "https://github.com/havunen/detective-vue2",
   "engines": {
-    "node": "^12.20.0 || ^14.14.0 || >=16.0.0"
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "typescript": "^5.4.4"
   },
-  "license": "MIT",
-  "homepage": "https://github.com/dependents/detective-typescript",
   "dependencies": {
-    "@vue/compiler-sfc": ">=3",
-    "detective-es6": ">=4",
-    "detective-sass": ">=5",
-    "detective-scss": ">=4",
-    "detective-stylus": ">=4",
-    "detective-typescript": ">=11"
+    "@vue/compiler-sfc": "^3.4.21",
+    "detective-es6": "^5.0.0",
+    "detective-sass": "^6.0.0",
+    "detective-scss": "^5.0.0",
+    "detective-stylus": "^5.0.0",
+    "detective-typescript": "^13.0.0"
   },
   "devDependencies": {
-    "eslint": "^8.48.0",
-    "mocha": "^10.2.0"
+    "c8": "^9.1.0",
+    "mocha": "^10.4.0",
+    "xo": "^0.58.0"
+  },
+  "xo": {
+    "space": true,
+    "ignores": [
+      "test/fixtures/*"
+    ],
+    "rules": {
+      "arrow-body-style": "off",
+      "capitalized-comments": "off",
+      "comma-dangle": [
+        "error",
+        "never"
+      ],
+      "curly": [
+        "error",
+        "multi-line"
+      ],
+      "operator-linebreak": [
+        "error",
+        "after"
+      ],
+      "object-curly-spacing": [
+        "error",
+        "always"
+      ],
+      "space-before-function-paren": [
+        "error",
+        "never"
+      ],
+      "unicorn/prefer-module": "off",
+      "unicorn/prefer-node-protocol": "off",
+      "unicorn/prefer-top-level-await": "off",
+      "unicorn/prevent-abbreviations": "off"
+    }
   }
 }