@sailshq/language-server 0.0.3 → 0.0.4

package/completions/sails-completions.js

@@ -0,0 +1,63 @@
+const lsp = require('vscode-languageserver/node')
+const loadSails = require('../helpers/load-sails')
+
+module.exports = async function sailsCompletions(document, position) {
+  const text = document.getText()
+  const offset = document.offsetAt(position)
+  const line = text.substring(0, offset).split('\n').pop()
+
+  const match = line.match(/sails((?:\.[a-zA-Z_$][0-9a-zA-Z_$]*)*)\.$/)
+  if (match) {
+    try {
+      return await loadSails(document.uri, (sailsApp) => {
+        const path = match[1].split('.').filter(Boolean)
+        return getNestedCompletions(sailsApp, path)
+      })
+    } catch (error) {
+      return []
+    }
+  }
+
+  return null
+}
+
+function getNestedCompletions(obj, path) {
+  let current = obj
+  for (const key of path) {
+    if (current && typeof current === 'object' && key in current) {
+      current = current[key]
+    } else {
+      return []
+    }
+  }
+
+  if (typeof current !== 'object' || current === null) {
+    return []
+  }
+
+  const completions = Object.keys(current).map((key) => {
+    const value = current[key]
+    let kind = lsp.CompletionItemKind.Property
+    let detail = 'Property'
+
+    if (typeof value === 'function') {
+      kind = lsp.CompletionItemKind.Method
+      detail = 'Method'
+    } else if (typeof value === 'object' && value !== null) {
+      detail = 'Object'
+    }
+
+    return {
+      label: key,
+      kind: kind,
+      detail: detail,
+      documentation: `Access to sails${path.length ? '.' + path.join('.') : ''}.${key}`,
+      sortText: key.startsWith('_') ? `z${key}` : key // Add this line
+    }
+  })
+
+  // Sort the completions
+  completions.sort((a, b) => a.sortText.localeCompare(b.sortText))
+
+  return completions
+}

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

@@ -1,7 +1,6 @@
 const lsp = require('vscode-languageserver/node')
 const path = require('path')
-const fs = require('fs').promises
-const url = require('url')
+const findFnLine = require('../helpers/find-fn-line')
 
 module.exports = async function goToAction(document, position) {
   const fileName = path.basename(document.uri)
@@ -65,18 +64,3 @@ function extractActionInfo(document, position) {
 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/go-to-definitions/go-to-helper.js

@@ -0,0 +1,47 @@
+const lsp = require('vscode-languageserver/node')
+const path = require('path')
+const fs = require('fs').promises
+const findProjectRoot = require('../helpers/find-project-root')
+const findFnLine = require('../helpers/find-fn-line')
+
+module.exports = async function goToHelper(document, position) {
+  const helperInfo = extractHelperInfo(document, position)
+
+  if (!helperInfo) {
+    return null
+  }
+
+  const projectRoot = await findProjectRoot(document.uri)
+  const fullHelperPath =
+    path.join(projectRoot, 'api', 'helpers', ...helperInfo.helperPath) + '.js'
+
+  if (fullHelperPath) {
+    const fnLineNumber = await findFnLine(fullHelperPath)
+    return lsp.Location.create(
+      fullHelperPath,
+      lsp.Range.create(fnLineNumber, 0, fnLineNumber, 0)
+    )
+  }
+}
+
+function extractHelperInfo(document, position) {
+  const text = document.getText()
+  const offset = document.offsetAt(position)
+
+  // Regular expression to match sails.helpers.exampleHelper() or sails.helpers.exampleHelper.with()
+  // Also matches nested helpers like sails.helpers.mail.send() or sails.helpers.mail.send.with()
+  const regex = /sails\.helpers\.([a-zA-Z0-9.]+)(?:\.with)?\s*\(/g
+  let match
+
+  while ((match = regex.exec(text)) !== null) {
+    const start = match.index
+    const end = start + match[0].length
+
+    if (start <= offset && offset <= end) {
+      const helperPath = match[1].split('.').filter((part) => part !== 'with')
+      return { helperPath }
+    }
+  }
+
+  return null
+}

package/go-to-definitions/go-to-inertia-page.js

@@ -0,0 +1,53 @@
+const lsp = require('vscode-languageserver/node')
+const path = require('path')
+const fs = require('fs').promises
+const findProjectRoot = require('../helpers/find-project-root')
+
+module.exports = async function goToInertiaPage(document, position) {
+  const pageInfo = extractPageInfo(document, position)
+
+  if (!pageInfo) {
+    return null
+  }
+
+  const projectRoot = await findProjectRoot(document.uri)
+  const possibleExtensions = ['.js', '.jsx', '.ts', '.tsx', '.vue', '.svelte'] // Add or remove extensions as needed
+
+  for (const ext of possibleExtensions) {
+    const fullPagePath = path.join(
+      projectRoot,
+      'assets',
+      'js',
+      'pages',
+      `${pageInfo.page}${ext}`
+    )
+    try {
+      await fs.access(fullPagePath)
+      return lsp.Location.create(fullPagePath, lsp.Range.create(0, 0, 0, 0))
+    } catch (error) {
+      // File doesn't exist with this extension, try the next one
+    }
+  }
+
+  return null
+}
+
+function extractPageInfo(document, position) {
+  const text = document.getText()
+  const offset = document.offsetAt(position)
+
+  // Regular expression to match { page: 'example' } or { page: "example" }
+  const regex = /{\s*page\s*:\s*['"]([^'"]+)['"]\s*}/g
+  let match
+
+  while ((match = regex.exec(text)) !== null) {
+    const start = match.index
+    const end = start + match[0].length
+
+    if (start <= offset && offset <= end) {
+      return { page: match[1] }
+    }
+  }
+
+  return null
+}

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

@@ -0,0 +1,90 @@
+const lsp = require('vscode-languageserver/node')
+const path = require('path')
+const fs = require('fs').promises
+
+module.exports = async function goToPolicy(document, position) {
+  const fileName = path.basename(document.uri)
+
+  if (fileName !== 'policies.js') {
+    return null
+  }
+
+  const policyInfo = extractPolicyInfo(document, position)
+
+  if (!policyInfo) {
+    return null
+  }
+
+  const projectRoot = path.dirname(path.dirname(document.uri))
+  const fullPolicyPath = resolvePolicyPath(projectRoot, policyInfo.policy)
+
+  if (await fileExists(fullPolicyPath)) {
+    return lsp.Location.create(fullPolicyPath, lsp.Range.create(0, 0, 0, 0))
+  }
+
+  return null
+}
+
+function extractPolicyInfo(document, position) {
+  const text = document.getText()
+  const offset = document.offsetAt(position)
+
+  // This regex matches policy definitions, including arrays of policies and boolean values
+  const regex =
+    /(['"])((?:\*|[\w-]+(?:\/\*?)?))?\1\s*:\s*((?:\[?\s*(?:(?:['"][\w-]+['"](?:\s*,\s*)?)+)\s*\]?)|true|false)/g
+  let match
+
+  while ((match = regex.exec(text)) !== null) {
+    const [fullMatch, , route, policiesOrBoolean] = 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) {
+      // If policiesOrBoolean is a boolean, ignore it
+      if (policiesOrBoolean === true || policiesOrBoolean === false) {
+        continue
+      }
+
+      // Remove brackets if present and split into individual policies
+      const policies = policiesOrBoolean
+        .replace(/^\[|\]$/g, '')
+        .split(',')
+        .map((p) => p.trim().replace(/^['"]|['"]$/g, ''))
+
+      // Find which policy the cursor is on
+      let currentStart = start + fullMatch.indexOf(policiesOrBoolean)
+      for (const policy of policies) {
+        const policyStart = text.indexOf(policy, currentStart)
+        const policyEnd = policyStart + policy.length
+
+        if (offset >= policyStart && offset <= policyEnd) {
+          return {
+            policy,
+            range: lsp.Range.create(
+              document.positionAt(policyStart),
+              document.positionAt(policyEnd)
+            )
+          }
+        }
+
+        currentStart = policyEnd
+      }
+    }
+  }
+
+  return null
+}
+
+function resolvePolicyPath(projectRoot, policyPath) {
+  return path.join(projectRoot, 'api', 'policies', `${policyPath}.js`)
+}
+
+async function fileExists(filePath) {
+  try {
+    await fs.access(new URL(filePath))
+    return true
+  } catch {
+    return false
+  }
+}

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

@@ -0,0 +1,70 @@
+const lsp = require('vscode-languageserver/node')
+const path = require('path')
+const fs = require('fs').promises
+
+const findProjectRoot = require('../helpers/find-project-root')
+
+module.exports = async function goToView(document, position) {
+  const viewInfo = extractViewInfo(document, position)
+
+  if (!viewInfo) {
+    return null
+  }
+
+  const projectRoot = await findProjectRoot(document.uri)
+
+  const fullViewPath = resolveViewPath(projectRoot, viewInfo.view)
+
+  try {
+    await fs.access(fullViewPath)
+    return lsp.Location.create(fullViewPath, lsp.Range.create(0, 0, 0, 0))
+  } catch (error) {
+    return null
+  }
+}
+
+function resolveViewPath(projectRoot, viewPath) {
+  return path.join(projectRoot, 'views', `${viewPath}.ejs`)
+}
+
+function extractViewInfo(document, position) {
+  const text = document.getText()
+  const offset = document.offsetAt(position)
+
+  // This regex matches both object notation for views and viewTemplatePath
+  const regex =
+    /(?:(['"])(.+?)\1\s*:\s*{\s*view\s*:\s*(['"])(.+?)\3\s*}|viewTemplatePath\s*:\s*(['"])(.+?)\5)/g
+  let match
+
+  while ((match = regex.exec(text)) !== null) {
+    const [fullMatch, , , , viewInObject, , viewInController] = match
+    const view = viewInObject || viewInController
+    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 view part, including quotes
+      const viewStartWithQuote = text.lastIndexOf(
+        "'",
+        text.indexOf(view, start)
+      ) // Find the opening quote
+      const viewEndWithQuote =
+        text.indexOf("'", text.indexOf(view, start) + view.length) + 1 // Find the closing quote and include it
+
+      return {
+        view,
+        range: lsp.Range.create(
+          document.positionAt(viewStartWithQuote),
+          document.positionAt(viewEndWithQuote)
+        )
+      }
+    }
+  }
+
+  return null
+}
+
+function resolveViewPath(projectRoot, viewPath) {
+  return path.join(projectRoot, 'views', `${viewPath}.ejs`)
+}

package/helpers/find-fn-line.js

@@ -0,0 +1,21 @@
+const fs = require('fs').promises
+const url = require('url')
+
+module.exports = async function findFnLine(filePath) {
+  try {
+    const resolvedPath = filePath.startsWith('file:')
+      ? url.fileURLToPath(filePath)
+      : filePath
+
+    const content = await fs.readFile(resolvedPath, '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/helpers/find-project-root.js

@@ -0,0 +1,18 @@
+const path = require('path')
+const url = require('url')
+const fs = require('fs').promises
+
+module.exports = async function findProjectRoot(uri) {
+  let currentPath = path.dirname(url.fileURLToPath(uri))
+  const root = path.parse(currentPath).root
+
+  while (currentPath !== root) {
+    try {
+      await fs.access(path.join(currentPath, 'package.json'))
+      return currentPath
+    } catch (error) {
+      currentPath = path.dirname(currentPath)
+    }
+  }
+  throw new Error('Could not find project root')
+}

package/helpers/find-sails.js

@@ -0,0 +1,12 @@
+const path = require('path')
+const fs = require('fs')
+const findProjectRoot = require('./find-project-root')
+
+module.exports = async function findSails(workspaceUri) {
+  const projectRoot = await findProjectRoot(workspaceUri)
+  const sailsPath = path.join(projectRoot, 'node_modules', 'sails')
+  if (fs.existsSync(sailsPath)) {
+    return { sailsPath, projectRoot }
+  }
+  throw new Error('Sails not found in node_modules')
+}

package/helpers/load-sails.js

@@ -0,0 +1,38 @@
+const findSails = require('./find-sails')
+
+module.exports = async function loadSails(workspaceUri, operation) {
+  let Sails
+  let sailsApp
+
+  try {
+    const { sailsPath } = await findSails(workspaceUri)
+    Sails = require(sailsPath).constructor
+
+    sailsApp = await new Promise((resolve, reject) => {
+      new Sails().load(
+        {
+          hooks: { shipwright: false },
+          log: { level: 'silent' }
+        },
+        (err, sails) => {
+          if (err) {
+            console.error('Failed to load Sails app:', err)
+            return reject(err)
+          }
+          resolve(sails)
+        }
+      )
+    })
+
+    // Execute the operation with the loaded Sails app
+    return await operation(sailsApp)
+  } catch (error) {
+    console.error('Error loading or working with Sails app:', error)
+    throw error
+  } finally {
+    // Ensure Sails is lowered even if an error occurred
+    if (sailsApp && typeof sailsApp.lower === 'function') {
+      await new Promise((resolve) => sailsApp.lower(resolve))
+    }
+  }
+}

package/index.js

@@ -1,7 +1,18 @@
 const lsp = require('vscode-languageserver/node')
 const TextDocument = require('vscode-languageserver-textdocument').TextDocument
+
+// Validators
 const validateDocument = require('./validators/validate-document')
+
+// Go-to definitions
 const goToAction = require('./go-to-definitions/go-to-action')
+const goToPolicy = require('./go-to-definitions/go-to-policy')
+const goToView = require('./go-to-definitions/go-to-view')
+const goToInertiaPage = require('./go-to-definitions/go-to-inertia-page')
+const goToHelper = require('./go-to-definitions/go-to-helper')
+
+// Completions
+const sailsCompletions = require('./completions/sails-completions')
 
 const connection = lsp.createConnection(lsp.ProposedFeatures.all)
 const documents = new lsp.TextDocuments(TextDocument)
@@ -10,11 +21,10 @@ connection.onInitialize((params) => {
   return {
     capabilities: {
       textDocumentSync: lsp.TextDocumentSyncKind.Incremental,
-      definitionProvider: true
-      // completionProvider: {
-      //   resolveProvider: true,
-      //   triggerCharacters: ['"', "'", '.']
-      // }
+      definitionProvider: true,
+      completionProvider: {
+        triggerCharacters: ['"', "'", '.']
+      }
     }
   }
 })
@@ -32,11 +42,45 @@ connection.onDefinition(async (params) => {
   if (!document) {
     return null
   }
-  const definitions = []
-  const actionDefinitions = await goToAction(document, params.position)
-  definitions.push(actionDefinitions)
-  return definitions || null
+
+  const actionDefinition = await goToAction(document, params.position)
+  const policyDefinition = await goToPolicy(document, params.position)
+  const viewDefinition = await goToView(document, params.position)
+  const inertiaPageDefinition = await goToInertiaPage(document, params.position)
+  const helperDefinition = await goToHelper(document, params.position)
+
+  const definitions = [
+    actionDefinition,
+    policyDefinition,
+    viewDefinition,
+    inertiaPageDefinition,
+    helperDefinition
+  ].filter(Boolean)
+
+  return definitions.length > 0 ? definitions : null
+})
+
+connection.onCompletion(async (params) => {
+  const document = documents.get(params.textDocument.uri)
+  if (!document) {
+    return null
+  }
+
+  const completions = await sailsCompletions(document, params.position)
+
+  if (completions) {
+    return {
+      isIncomplete: false,
+      items: completions
+    }
+  }
+
+  return null
 })
 
 documents.listen(connection)
 connection.listen()
+
+connection.console.log = (message) => {
+  console.log(message)
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailshq/language-server",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Language Server Protocol server for Sails Language Service",
   "homepage": "https://sailjs.com",
   "repository": {

package/validators/validate-action-exist.js

@@ -18,6 +18,10 @@ module.exports = function validateActionExist(document) {
   const actions = extractActionInfo(document) // Get all actions
 
   for (const { action, range } of actions) {
+    if (isUrlOrRedirect(action)) {
+      continue
+    }
+
     const fullActionPath = resolveActionPath(projectRoot, action)
     if (!fs.existsSync(url.fileURLToPath(fullActionPath))) {
       const diagnostic = {
@@ -63,3 +67,15 @@ function extractActionInfo(document) {
 function resolveActionPath(projectRoot, actionPath) {
   return path.join(projectRoot, 'api', 'controllers', `${actionPath}.js`)
 }
+
+function isUrlOrRedirect(action) {
+  if (action.startsWith('http://') || action.startsWith('https://')) {
+    return true
+  }
+
+  if (action.startsWith('/')) {
+    return true
+  }
+
+  return false
+}