Init stimulus-parser

marcoroth · marcoroth · commit ae2746ff29e4 · 2023-09-08T03:00:47.000+02:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+dist/**/*.*
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,22 @@
+{
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint",
+    "prettier"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": ["error"],
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }]
+  },
+  "env": {
+    "node": true
+  }
+}
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+types/**/* linguist-vendored
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
@@ -0,0 +1,45 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+  schedule:
+    - cron: "49 0 * * 6"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [javascript]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{ matrix.language }}"
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,14 @@
+*.tgz
+*.tsbuildinfo
+*.log
+*~
+
+/dist
+node_modules/
+coverage/
+
+yarn-error.log
+
+.DS_Store
+.rollup.cache
+.tool-versions
diff --git a/.node-version b/.node-version
@@ -0,0 +1 @@
+20.5.1
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,25 @@
+.babelrc
+.babelrc.js
+.DS_Store
+.gitignore
+.yarn.lock
+
+*.log
+*.tsbuildinfo
+*.tgz
+
+README.md
+rollup.config.js
+tsconfig.json
+yarn-error.log
+*~
+
+/.git
+/.github
+/.gitattributes
+
+/node_modules
+/src
+/test
+/coverage
+/assets
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -0,0 +1,5 @@
+ {
+   "singleQuote": false,
+   "printWidth": 120,
+   "semi": false
+ }
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Marco Roth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,39 @@
+<h1 align="center">stimulus-parser</h1>
+
+<p align="center">
+  <a href="https://github.com/marcoroth/stimulus-parser">
+    <img src="https://github.com/marcoroth/stimulus-parser/actions/workflows/tests.yml/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/stimulus-parser">
+    <img alt="NPM Version" src="https://img.shields.io/npm/v/stimulus-parser?logo=npm&color=38C160">
+  </a>
+  <a href="https://www.npmjs.com/package/stimulus-parser">
+    <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/stimulus-parser?logo=npm&color=38C160">
+  </a>
+  <a href="https://bundlephobia.com/package/stimulus-parser">
+    <img alt="NPM Bundle Size" src="https://img.shields.io/bundlephobia/minzip/stimulus-parser?label=bundle%20size&logo=npm">
+  </a>
+</p>
+
+
+## Installation
+
+To add `stimulus-parser` to your project, run the following command in your terminal:
+
+```bash
+yarn add stimulus-parser
+```
+
+## Usage
+
+TODO
+
+## Development
+
+To run the tests:
+
+```bash
+yarn install
+yarn build
+yarn test
+```
diff --git a/package.json b/package.json
@@ -0,0 +1,45 @@
+{
+  "name": "stimulus-parser",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Statically analyze Stimulus controllers",
+  "main": "dist/stimulus-parser.js",
+  "module": "dist/stimulus-parser.js",
+  "types": "dist/types/stimulus-parser.d.ts",
+  "author": "Marco Roth",
+  "license": "MIT",
+  "repository": "https://github.com/marcoroth/stimulus-parser",
+  "sideEffects": false,
+  "scripts": {
+    "prebuild": "yarn clean",
+    "build": "tsc --noEmit false --declaration true --emitDeclarationOnly true --outDir dist/types && rollup -c",
+    "watch": "rollup -wc",
+    "dev": "watch",
+    "clean": "rimraf dist",
+    "prerelease": "yarn build",
+    "lint": "eslint .",
+    "format": "yarn lint --fix"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.1.0",
+    "@rollup/plugin-terser": "^0.4.3",
+    "@rollup/plugin-typescript": "^11.1.2",
+    "@types/glob": "^8.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "@typescript-eslint/parser": "^5.60.1",
+    "acorn": "^8.8.2",
+    "acorn-static-class-features": "^1.0.0",
+    "acorn-walk": "^8.2.0",
+    "eslint": "^8.44.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "fs": "^0.0.1-security",
+    "path": "^0.12.7",
+    "prettier": "^2.8.8",
+    "rimraf": "^5.0.1",
+    "rollup": "^3.29.0",
+    "rollup-plugin-filesize": "^10.0.0",
+    "tslib": "^2.6.2",
+    "typescript": "^5.2.2"
+  }
+}
diff --git a/rollup.config.mjs b/rollup.config.mjs
@@ -0,0 +1,21 @@
+import resolve from "@rollup/plugin-node-resolve"
+import typescript from "@rollup/plugin-typescript"
+
+export default [
+  {
+    input: "src/index.ts",
+    output: [
+      {
+        file: "dist/stimulus-parser.js",
+        format: "esm",
+      },
+    ],
+    plugins: [
+      resolve(),
+      typescript(),
+    ],
+    watch: {
+      include: "src/**",
+    },
+  },
+]
diff --git a/src/controller_definition.ts b/src/controller_definition.ts
@@ -0,0 +1,23 @@
+export interface ControllerDefinition {
+  identifier: string
+  dasherized: string
+  methods: Array<string>
+  targets: Array<string>
+  classes: Array<string>
+  values: { [key: string]: string }
+}
+
+// export class ControllerDefinition {
+//   readonly identifier: string
+//   readonly path: string
+//
+//   readonly targets = []
+//   readonly values = []
+//   readonly classes = []
+//   readonly outlets = []
+//
+//   constructor(identifier: string, path: string) {
+//     this.identifier = identifier
+//     this.path = path
+//   }
+// }
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,4 @@
+export * from "./controller_definition"
+export * from "./parser"
+export * from "./project"
+export * from "./types"
diff --git a/src/parser.ts b/src/parser.ts
@@ -0,0 +1,69 @@
+import { simple } from "acorn-walk"
+import { Parser as AcornParser } from "acorn"
+import staticClassFeatures from "acorn-static-class-features"
+
+import { dasherize, camelize } from "./util"
+
+import { ControllerDefinition } from "./controller_definition"
+import { NodeElement, PropertyElement } from "./types"
+
+export class Parser {
+  private parser: typeof AcornParser
+
+  constructor() {
+    this.parser = AcornParser.extend(staticClassFeatures)
+  }
+
+  parse(code: string) {
+    return this.parser.parse(code, {
+      sourceType: "module",
+      ecmaVersion: 2020,
+    })
+  }
+
+  parseController(code: string, filename: string) {
+    const ast = this.parse(code)
+
+    // TODO also check for namespaced controllers
+    const splits = filename.split("/")
+    const fileName = splits[splits.length - 1]
+    const identifier = fileName.split("_controller.js")[0]
+
+    const controller: ControllerDefinition = {
+      identifier: identifier,
+      dasherized: dasherize(camelize(identifier)),
+      methods: [],
+      targets: [],
+      classes: [],
+      values: {},
+    }
+
+    simple(ast, {
+      MethodDefinition(node: any): void {
+        if (node.kind === "method") {
+          controller.methods.push(node.key.name)
+        }
+      },
+
+      PropertyDefinition(node: any): void {
+        const { name } = node.key
+
+        if (name === "targets") {
+          controller.targets = node.value.elements.map((element: NodeElement) => element.value)
+        }
+
+        if (name === "classes") {
+          controller.classes = node.value.elements.map((element: NodeElement) => element.value)
+        }
+
+        if (name === "values") {
+          node.value.properties.forEach((property: PropertyElement) => {
+            controller.values[property.key.name] = property.value.name
+          })
+        }
+      },
+    })
+
+    return controller
+  }
+}
diff --git a/src/project.ts b/src/project.ts
@@ -0,0 +1,42 @@
+import { ControllerDefinition } from "./controller_definition"
+import { Parser } from "./parser"
+
+import * as fs from "fs"
+import { glob } from "glob"
+
+interface ControllerFile {
+  filename: string
+  content: string
+}
+
+export class Project {
+  readonly projectPath: string
+  readonly controllerDefinitions: ControllerDefinition[] = []
+  private controllersFiles: Array<ControllerFile> = []
+
+  private parser: Parser = new Parser()
+
+  constructor(projectPath: string) {
+    this.projectPath = projectPath
+  }
+
+  async analyze() {
+    await this.detectControllerFiles()
+
+    this.controllersFiles.forEach((file: ControllerFile) => {
+      this.controllerDefinitions.push(this.parser.parseController(file.content, file.filename))
+    })
+  }
+
+  async detectControllerFiles() {
+    const controllerFiles = await glob(`${this.projectPath}/**/*_controller.js`, {
+      ignore: `${this.projectPath}/node_modules/**/*`,
+    })
+
+    controllerFiles.forEach((filename: string) => {
+      fs.readFile(filename, "utf8", (_err: any, content) => {
+        this.controllersFiles.push({ filename, content })
+      })
+    })
+  }
+}
diff --git a/src/types.ts b/src/types.ts
diff --git a/src/util.ts b/src/util.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/types/acorn-static-class-features/index.d.ts b/types/acorn-static-class-features/index.d.ts
diff --git a/yarn.lock b/yarn.lock
