Merge pull request #7 from makeplane/fix-node-support-lint-ci

Fix node support, lint, format and add CI

Author: Prashant-Surya

.eslintrc.json

@@ -0,0 +1,30 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ $default-branch ]
+  pull_request:
+    branches: [ $default-branch ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x, 22.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm test

.github/workflows/ci.yml

@@ -13,9 +13,9 @@ The Plane MCP Server is a Model Context Protocol (MCP) server that provides seam
 
 ## Configuration Parameters
 
-1. `PLANE_API_HOST_URL` - The host URL of the Plane API Server. Defaults to https://api.plane.so/
-2. `PLANE_API_KEY` - The user's API token. This can be obtained from the `/settings/api-tokens/` page in the UI.
-3. `PLANE_WORKSPACE_SLUG` - The workspace slug for your Plane instance.
+1. `PLANE_API_KEY` - The user's API token. This can be obtained from the `/settings/api-tokens/` page in the UI.
+2. `PLANE_WORKSPACE_SLUG` - The workspace slug for your Plane instance.
+3. `PLANE_API_HOST_URL` (optional) - The host URL of the Plane API Server. Defaults to https://api.plane.so/
 
 ## Tools
 

README.md

@@ -0,0 +1,53 @@
+import { FlatCompat } from "@eslint/eslintrc";
+import js from "@eslint/js";
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import tsParser from "@typescript-eslint/parser";
+import prettier from "eslint-plugin-prettier";
+import { defineConfig, globalIgnores } from "eslint/config";
+import globals from "globals";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+  baseDirectory: __dirname,
+  recommendedConfig: js.configs.recommended,
+  allConfig: js.configs.all,
+});
+
+export default defineConfig([
+  globalIgnores(["build/"]),
+  {
+    extends: compat.extends(
+      "eslint:recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:prettier/recommended",
+      "prettier"
+    ),
+
+    plugins: {
+      "@typescript-eslint": typescriptEslint,
+      prettier,
+    },
+
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+
+      parser: tsParser,
+      ecmaVersion: "latest",
+      sourceType: "module",
+    },
+
+    rules: {
+      "prettier/prettier": "error",
+      indent: ["error", 2],
+      semi: ["error", "always"],
+      "linebreak-style": ["error", "unix"],
+      "@typescript-eslint/explicit-function-return-type": "warn",
+      "@typescript-eslint/no-explicit-any": "warn",
+    },
+  },
+]);

eslint.config.mjs

@@ -13,6 +13,8 @@
     "lint:fix": "eslint . --ext .ts --fix",
     "format": "prettier --write \"src/**/*.ts\"",
     "format:check": "prettier --check \"src/**/*.ts\"",
+    "test-startup": "node build/server.js",
+    "test": "npm run lint && npm run format:check && npm run build && npm run test-startup",
     "prepublishOnly": "npm run build"
   },
   "files": [
@@ -34,13 +36,16 @@
     "zod-to-json-schema": "^3.24.5"
   },
   "devDependencies": {
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.25.0",
     "@trivago/prettier-plugin-sort-imports": "^5.2.2",
     "@types/node": "^22.14.0",
     "@typescript-eslint/eslint-plugin": "^8.29.1",
     "@typescript-eslint/parser": "^8.29.1",
     "eslint": "^9.24.0",
     "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-prettier": "^5.2.6",
+    "globals": "^16.0.0",
     "json-schema-to-zod": "^2.6.1",
     "prettier": "^3.5.3",
     "typescript": "^5.8.3",

package-lock.json

@@ -1,7 +1,7 @@
 import axios, { AxiosRequestConfig } from "axios";
 
 export async function makePlaneRequest<T>(method: string, path: string, body: any = null): Promise<T> {
-  const hostUrl = process.env.PLANE_API_HOST_URL || "";
+  const hostUrl = process.env.PLANE_API_HOST_URL || "https://api.plane.so/";
   const host = hostUrl.endsWith("/") ? hostUrl : `${hostUrl}/`;
   const url = `${host}api/v1/${path}`;
   const headers: Record<string, string> = {

package.json

@@ -1,4 +1,7 @@
-import pkg from "../../package.json" with { type: "json" };
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+const pkg = require("../../package.json");
 
 export function getVersion() {
   return pkg.version;

src/common/request-helper.ts

@@ -1,21 +1,10 @@
 #!/usr/bin/env node
-
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { registerTools } from "./tools/index.js";
-import { getVersion } from "./common/version.js";
-
-async function main() {
-  const version = getVersion();
 
-  const server = new McpServer({
-    name: "plane-mcp-server",
-    version,
-    capabilities: {},
-  });
-
-  registerTools(server);
+import { createServer } from "./server.js";
 
+async function main() {
+  const { server, version } = createServer();
   const transport = new StdioServerTransport();
   await server.connect(transport);
   console.error(`Plane MCP Server running on stdio: ${version}`);

src/common/version.ts

@@ -0,0 +1,18 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+
+import { getVersion } from "./common/version.js";
+import { registerTools } from "./tools/index.js";
+
+export function createServer() {
+  const version = getVersion();
+
+  const server = new McpServer({
+    name: "plane-mcp-server",
+    version,
+    capabilities: {},
+  });
+
+  registerTools(server);
+
+  return { server, version };
+}