@sailshq/language-server 0.0.1

package/bin/server.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+if (process.argv.includes('--version')) {
+  const pkgJSON = require('../package.json')
+  console.log(`${pkgJSON['version']}`)
+} else {
+  require('../index.js')
+}

package/go-to-definitions/go-to-action.js

@@ -0,0 +1,82 @@
+const lsp = require('vscode-languageserver/node')
+const path = require('path')
+const fs = require('fs').promises
+const url = require('url')
+
+module.exports = async function goToAction(document, position) {
+  const fileName = path.basename(document.uri)
+
+  if (fileName !== 'routes.js') {
+    return null
+  }
+  const actionInfo = extractActionInfo(document, position)
+
+  if (!actionInfo) {
+    return null
+  }
+
+  const projectRoot = path.dirname(path.dirname(document.uri))
+
+  const fullActionPath = resolveActionPath(projectRoot, actionInfo.action)
+
+  if (fullActionPath) {
+    const fnLineNumber = await findFnLine(fullActionPath)
+    return lsp.Location.create(
+      fullActionPath,
+      lsp.Range.create(fnLineNumber, 0, fnLineNumber, 0)
+    )
+  }
+
+  return null
+}
+
+function extractActionInfo(document, position) {
+  const text = document.getText()
+  const offset = document.offsetAt(position)
+
+  // This regex matches both object and string notations
+  const regex = /(['"])(.+?)\1:\s*(?:{?\s*action\s*:\s*)?(['"])(.+?)\3/g
+  let match
+
+  while ((match = regex.exec(text)) !== null) {
+    const [fullMatch, , route, , action] = match
+    const start = match.index
+    const end = start + fullMatch.length
+
+    // Check if the cursor is anywhere within the entire match
+    if (start <= offset && offset <= end) {
+      // Find the start and end positions of the action part
+      const actionStart = text.indexOf(action, start)
+      const actionEnd = actionStart + action.length
+
+      return {
+        action,
+        range: lsp.Range.create(
+          document.positionAt(actionStart),
+          document.positionAt(actionEnd)
+        )
+      }
+    }
+  }
+
+  return null
+}
+
+function resolveActionPath(projectRoot, actionPath) {
+  return path.join(projectRoot, 'api', 'controllers', `${actionPath}.js`)
+}
+
+async function findFnLine(filePath) {
+  try {
+    const content = await fs.readFile(url.fileURLToPath(filePath), 'utf8')
+    const lines = content.split('\n')
+    for (let i = 0; i < lines.length; i++) {
+      if (lines[i].includes('fn:')) {
+        return i // Return the line number (0-based index)
+      }
+    }
+    return 0 // If 'fn:' is not found, return the first line
+  } catch (error) {
+    return 0 // Return the first line if there's an error
+  }
+}

package/index.js

@@ -0,0 +1,42 @@
+const lsp = require('vscode-languageserver/node')
+const TextDocument = require('vscode-languageserver-textdocument').TextDocument
+const validateDocument = require('./validators/validate-document')
+const goToAction = require('./go-to-definitions/go-to-action')
+
+const connection = lsp.createConnection(lsp.ProposedFeatures.all)
+const documents = new lsp.TextDocuments(TextDocument)
+
+connection.onInitialize((params) => {
+  return {
+    capabilities: {
+      textDocumentSync: lsp.TextDocumentSyncKind.Incremental,
+      definitionProvider: true
+      // completionProvider: {
+      //   resolveProvider: true,
+      //   triggerCharacters: ['"', "'", '.']
+      // }
+    }
+  }
+})
+
+documents.onDidOpen((open) => {
+  validateDocument(connection, open.document)
+})
+
+documents.onDidChangeContent((change) => {
+  validateDocument(connection, change.document)
+})
+
+connection.onDefinition(async (params) => {
+  const document = documents.get(params.textDocument.uri)
+  if (!document) {
+    return null
+  }
+  const definitions = []
+  const actionDefinitions = await goToAction(document, params.position)
+  definitions.push(actionDefinitions)
+  return definitions || null
+})
+
+documents.listen(connection)
+connection.listen()

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@sailshq/language-server",
+  "version": "0.0.1",
+  "description": "Language Server Protocol server for Sails Language Service",
+  "homepage": "https://sailjs.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sailshq/language-tools",
+    "directory": "packages/language-server"
+  },
+  "main": "index.js",
+  "bin": {
+    "sails-language-server": "./bin/sails-language-server.js"
+  },
+  "scripts": {
+    "start": "node server.js",
+    "watch": "node --watch server.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Kelvin Omereshone",
+  "license": "MIT",
+  "dependencies": {
+    "vscode-languageserver": "^9.0.1",
+    "vscode-languageserver-textdocument": "^1.0.12"
+  }
+}

package/validators/validate-action-exist.js

@@ -0,0 +1,65 @@
+const lsp = require('vscode-languageserver/node')
+const path = require('path')
+const fs = require('fs')
+const url = require('url')
+module.exports = function validateActionExist(document) {
+  const diagnostics = []
+
+  if (!document.uri.endsWith('routes.js')) {
+    return diagnostics // Return empty diagnostics if not routes.js
+  }
+  const actionInfo = extractActionInfo(document)
+
+  if (!actionInfo) {
+    return diagnostics
+  }
+
+  const projectRoot = path.dirname(path.dirname(document.uri))
+  const actions = extractActionInfo(document) // Get all actions
+
+  for (const { action, range } of actions) {
+    const fullActionPath = resolveActionPath(projectRoot, action)
+    if (!fs.existsSync(url.fileURLToPath(fullActionPath))) {
+      const diagnostic = {
+        severity: lsp.DiagnosticSeverity.Error,
+        range,
+        message: `Action '${action}' does not exist. Please check the controller file.`,
+        source: 'Sails Validator'
+      }
+      diagnostics.push(diagnostic)
+    }
+  }
+
+  return diagnostics
+}
+
+function extractActionInfo(document) {
+  const text = document.getText()
+
+  // This regex matches both object and string notations
+  const regex = /(['"])(.+?)\1:\s*(?:{?\s*action\s*:\s*)?(['"])(.+?)\3/g
+  let match
+  const actions = []
+
+  while ((match = regex.exec(text)) !== null) {
+    const [fullMatch, , route, , action] = match
+
+    // Store the action and its range
+    const actionStart = match.index + fullMatch.indexOf(action)
+    const actionEnd = actionStart + action.length
+
+    actions.push({
+      action,
+      range: lsp.Range.create(
+        document.positionAt(actionStart),
+        document.positionAt(actionEnd)
+      )
+    })
+  }
+
+  return actions // Return an array of actions
+}
+
+function resolveActionPath(projectRoot, actionPath) {
+  return path.join(projectRoot, 'api', 'controllers', `${actionPath}.js`)
+}

package/validators/validate-auto-migration-strategy.js

@@ -0,0 +1,40 @@
+const lsp = require('vscode-languageserver')
+
+module.exports = function validateAutomigrationStrategy(document) {
+  const text = document.getText()
+
+  const migrationFiles = ['config/models.js', 'api/models/', 'config/env/']
+  const diagnostics = []
+
+  if (!migrationFiles.some((file) => document.uri.includes(file))) {
+    return diagnostics
+  }
+
+  const migrateRegex = /^\s*migrate:\s*['"](\w+)['"]\s*,?\s*$/m
+
+  const match = text.match(migrateRegex)
+  const validAutomigrationStrategies = ['safe', 'alter', 'drop']
+
+  if (match) {
+    const automigrationStrategy = match[1]
+    if (!validAutomigrationStrategies.includes(automigrationStrategy)) {
+      const startIndex = match.index + match[0].indexOf(automigrationStrategy)
+      const endIndex = startIndex + automigrationStrategy.length
+
+      const startPosition = document.positionAt(startIndex)
+      const endPosition = document.positionAt(endIndex)
+      const diagnostic = {
+        severity: lsp.DiagnosticSeverity.Error,
+        range: {
+          start: startPosition,
+          end: endPosition
+        },
+        message: `Invalid auto-migration strategy: '${automigrationStrategy}'. Supported strategies are: ${validAutomigrationStrategies.join(', ')}.`,
+        source: 'Sails Validator'
+      }
+      diagnostics.push(diagnostic)
+    }
+  }
+
+  return diagnostics
+}

package/validators/validate-document.js

@@ -0,0 +1,13 @@
+const validateAutomigrationStrategy = require('./validate-auto-migration-strategy')
+const validateActionExist = require('./validate-action-exist')
+
+module.exports = function validateDocument(connection, document) {
+  const diagnostics = []
+
+  const modelDiagnostics = validateAutomigrationStrategy(document)
+  const actionDiagnostics = validateActionExist(document)
+
+  diagnostics.push(...modelDiagnostics, ...actionDiagnostics)
+
+  connection.sendDiagnostics({ uri: document.uri, diagnostics })
+}