@sailshq/language-server 0.0.5 → 0.1.0

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

@@ -1,70 +1,43 @@
 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) {
+module.exports = async function goToView(document, position, typeMap) {
+  const fileName = path.basename(document.uri)
+  const filePath = document.uri
   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
+  const isRoutes = fileName === 'routes.js'
+  const isController = filePath.includes('/api/controllers/')
 
-  while ((match = regex.exec(text)) !== null) {
-    const [fullMatch, , , , viewInObject, , viewInController] = match
-    const view = viewInObject || viewInController
-    const start = match.index
-    const end = start + fullMatch.length
+  if (!isRoutes && !isController) return null
 
-    // 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
+  const regex =
+    /\b(viewTemplatePath|view)\s*:\s*(?<quote>['"])(?<view>[^'"]+)\k<quote>/g
 
-      return {
-        view,
-        range: lsp.Range.create(
-          document.positionAt(viewStartWithQuote),
-          document.positionAt(viewEndWithQuote)
+  let match
+  while ((match = regex.exec(text)) !== null) {
+    const viewName = match.groups.view
+    const quote = match.groups.quote
+    const fullMatchStart =
+      match.index + match[0].indexOf(quote + viewName + quote)
+    const fullMatchEnd = fullMatchStart + viewName.length + 2
+
+    if (offset >= fullMatchStart && offset <= fullMatchEnd) {
+      const viewPath = typeMap.views?.[viewName]
+      if (viewPath) {
+        const uri = `file://${viewPath.path}`
+        return lsp.LocationLink.create(
+          uri,
+          lsp.Range.create(0, 0, 0, 0),
+          lsp.Range.create(0, 0, 0, 0),
+          lsp.Range.create(
+            document.positionAt(fullMatchStart),
+            document.positionAt(fullMatchEnd)
+          )
         )
       }
     }
   }
-
   return null
 }
-
-function resolveViewPath(projectRoot, viewPath) {
-  return path.join(projectRoot, 'views', `${viewPath}.ejs`)
-}

package/index.js

@@ -1,40 +1,71 @@
 const lsp = require('vscode-languageserver/node')
 const TextDocument = require('vscode-languageserver-textdocument').TextDocument
+const SailsParser = require('./SailsParser')
 
 // 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 goToPage = require('./go-to-definitions/go-to-page')
+const goToPolicy = require('./go-to-definitions/go-to-policy')
 const goToHelper = require('./go-to-definitions/go-to-helper')
+const goToModel = require('./go-to-definitions/go-to-model')
 
 // Completions
-const sailsCompletions = require('./completions/sails-completions')
-
+const actionsCompletion = require('./completions/actions-completion')
+const dataTypesCompletion = require('./completions/data-types-completion')
+const modelAttributePropsCompletion = require('./completions/model-attribute-props-completion')
+const inputPropsCompletion = require('./completions/input-props-completion')
+const inertiaPagesCompletion = require('./completions/inertia-pages-completion')
+const modelsCompletion = require('./completions/models-completion')
+const policiesCompletion = require('./completions/policies-completion')
+const viewsCompletion = require('./completions/views-completion')
+const modelMethodsCompletion = require('./completions/model-methods-completion')
+const modelAttributesCompletion = require('./completions/model-attributes-completion')
 const connection = lsp.createConnection(lsp.ProposedFeatures.all)
 const documents = new lsp.TextDocuments(TextDocument)
 
-connection.onInitialize((params) => {
+// Create a new SailsParser instance
+const sailsParser = new SailsParser()
+let typeMap
+
+connection.onInitialize(async (params) => {
+  const rootPath = params.workspaceFolders?.[0]?.uri
+    ? new URL(params.workspaceFolders[0].uri).pathname
+    : undefined
+
+  sailsParser.setRootDir(rootPath)
+  typeMap = await sailsParser.buildTypeMap()
+
   return {
     capabilities: {
       textDocumentSync: lsp.TextDocumentSyncKind.Incremental,
       definitionProvider: true,
       completionProvider: {
-        triggerCharacters: ['"', "'", '.']
+        triggerCharacters: ['"', "'", '.', '{', ',', ' ', '\n']
       }
     }
   }
 })
 
 documents.onDidOpen((open) => {
-  validateDocument(connection, open.document)
+  if (typeMap) {
+    validateDocument(connection, open.document, typeMap)
+  }
 })
 
-documents.onDidChangeContent((change) => {
-  validateDocument(connection, change.document)
+documents.onDidChangeContent(async (change) => {
+  const documentUri = change.document.uri
+  if (documentUri.includes('api/') || documentUri.includes('config')) {
+    typeMap = await sailsParser.buildTypeMap()
+    connection.console.log('Type map updated due to file change.')
+  }
+
+  if (typeMap) {
+    validateDocument(connection, change.document, typeMap)
+  }
 })
 
 connection.onDefinition(async (params) => {
@@ -43,20 +74,30 @@ connection.onDefinition(async (params) => {
     return 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 [
+    actionDefinition,
+    viewDefinition,
+    pageDefinition,
+    policyDefinition,
+    helperDefinition,
+    modelDefinition
+  ] = await Promise.all([
+    goToAction(document, params.position, typeMap),
+    goToView(document, params.position, typeMap),
+    goToPage(document, params.position, typeMap),
+    goToPolicy(document, params.position, typeMap),
+    goToHelper(document, params.position, typeMap),
+    goToModel(document, params.position, typeMap)
+  ])
 
   const definitions = [
     actionDefinition,
-    policyDefinition,
     viewDefinition,
-    inertiaPageDefinition,
-    helperDefinition
+    pageDefinition,
+    policyDefinition,
+    helperDefinition,
+    modelDefinition
   ].filter(Boolean)
-
   return definitions.length > 0 ? definitions : null
 })
 
@@ -65,8 +106,42 @@ connection.onCompletion(async (params) => {
   if (!document) {
     return null
   }
-
-  const completions = await sailsCompletions(document, params.position)
+  const [
+    actionCompletion,
+    dataTypeCompletion,
+    modelAttributePropCompletion,
+    inputPropCompletion,
+    inertiaPageCompletion,
+    modelCompletion,
+    policyCompletion,
+    viewCompletion,
+    modelMethodCompletion,
+    modelAttributeCompletion
+  ] = await Promise.all([
+    actionsCompletion(document, params.position, typeMap),
+    dataTypesCompletion(document, params.position, typeMap),
+    modelAttributePropsCompletion(document, params.position, typeMap),
+    inputPropsCompletion(document, params.position, typeMap),
+    inertiaPagesCompletion(document, params.position, typeMap),
+    modelsCompletion(document, params.position, typeMap),
+    policiesCompletion(document, params.position, typeMap),
+    viewsCompletion(document, params.position, typeMap),
+    modelMethodsCompletion(document, params.position, typeMap),
+    modelAttributesCompletion(document, params.position, typeMap)
+  ])
+
+  const completions = [
+    ...actionCompletion,
+    ...dataTypeCompletion,
+    ...modelAttributePropCompletion,
+    ...inputPropCompletion,
+    ...inertiaPageCompletion,
+    ...modelCompletion,
+    ...policyCompletion,
+    ...viewCompletion,
+    ...modelMethodCompletion,
+    ...modelAttributeCompletion
+  ].filter(Boolean)
 
   if (completions) {
     return {

package/package.json

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

package/validators/validate-action-exist.js

@@ -1,55 +1,40 @@
 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
-  }
+module.exports = function validateActionExist(document, typeMap) {
+  const diagnostics = []
 
-  const projectRoot = path.dirname(path.dirname(document.uri))
-  const actions = extractActionInfo(document) // Get all actions
+  if (!document.uri.endsWith('routes.js')) return diagnostics
+  const actions = extractActionInfo(document)
 
   for (const { action, range } of actions) {
-    if (isUrlOrRedirect(action)) {
-      continue
-    }
-
-    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)
+    if (isUrlOrRedirect(action)) continue
+    const routeExists = Object.values(typeMap.routes || {}).some(
+      (route) => route.action?.name === action
+    )
+
+    if (!routeExists) {
+      diagnostics.push(
+        lsp.Diagnostic.create(
+          range,
+          `'${action}' action does not exist. Please check the name or create it.`,
+          lsp.DiagnosticSeverity.Error,
+          'sails-lsp'
+        )
+      )
     }
   }
-
   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 regex = /(['"])(.+?)\1\s*:\s*(?:{?\s*action\s*:\s*)?(['"])(.+?)\3/g
   const actions = []
+  let match
 
   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 action = match[4]
+    const actionStart = match.index + match[0].lastIndexOf(action)
     const actionEnd = actionStart + action.length
 
     actions.push({
@@ -61,21 +46,13 @@ function extractActionInfo(document) {
     })
   }
 
-  return actions // Return an array of actions
-}
-
-function resolveActionPath(projectRoot, actionPath) {
-  return path.join(projectRoot, 'api', 'controllers', `${actionPath}.js`)
+  return actions
 }
 
 function isUrlOrRedirect(action) {
-  if (action.startsWith('http://') || action.startsWith('https://')) {
-    return true
-  }
-
-  if (action.startsWith('/')) {
-    return true
-  }
-
-  return false
+  return (
+    action.startsWith('http://') ||
+    action.startsWith('https://') ||
+    action.startsWith('/')
+  )
 }

package/validators/validate-data-type.js

@@ -0,0 +1,34 @@
+const lsp = require('vscode-languageserver/node')
+
+module.exports = function validateDataType(document, typeMap) {
+  const diagnostics = []
+
+  const text = document.getText()
+
+  // Regex to match lines like: type: 'string' or type: "number"
+  const regex = /type\s*:\s*['"]([a-zA-Z0-9_-]+)['"]/g
+
+  let match
+  while ((match = regex.exec(text)) !== null) {
+    const dataType = match[1]
+    const typeStart = match.index + match[0].indexOf(dataType)
+    const typeEnd = typeStart + dataType.length
+
+    const isValid = typeMap.dataTypes.some((dt) => dt.type === dataType)
+
+    if (!isValid) {
+      diagnostics.push(
+        lsp.Diagnostic.create(
+          lsp.Range.create(
+            document.positionAt(typeStart),
+            document.positionAt(typeEnd)
+          ),
+          `'${dataType}' is not a recognized data type. Valid data types are: ${typeMap.dataTypes.map((dataType) => dataType.type).join(', ')}.`,
+          lsp.DiagnosticSeverity.Error,
+          'sails-lsp'
+        )
+      )
+    }
+  }
+  return diagnostics
+}

package/validators/validate-document.js

@@ -1,13 +1,29 @@
 const validateAutomigrationStrategy = require('./validate-auto-migration-strategy')
 const validateActionExist = require('./validate-action-exist')
-
-module.exports = function validateDocument(connection, document) {
+const validatePageExist = require('./validate-page-exist')
+const validateDataTypes = require('./validate-data-type')
+const validatePolicyExist = require('./validate-policy-exist')
+const validateModelAttributeExist = require('./validate-model-attribute-exist')
+module.exports = function validateDocument(connection, document, typeMap) {
   const diagnostics = []
 
   const modelDiagnostics = validateAutomigrationStrategy(document)
-  const actionDiagnostics = validateActionExist(document)
-
-  diagnostics.push(...modelDiagnostics, ...actionDiagnostics)
+  const actionDiagnostics = validateActionExist(document, typeMap)
+  const pageDiagnostics = validatePageExist(document, typeMap)
+  const dataTypeDiagnostics = validateDataTypes(document, typeMap)
+  const policyDiagnostics = validatePolicyExist(document, typeMap)
+  const modelAttributeDiagnostics = validateModelAttributeExist(
+    document,
+    typeMap
+  )
+  diagnostics.push(
+    ...modelDiagnostics,
+    ...actionDiagnostics,
+    ...pageDiagnostics,
+    ...dataTypeDiagnostics,
+    ...policyDiagnostics,
+    ...modelAttributeDiagnostics
+  )
 
   connection.sendDiagnostics({ uri: document.uri, diagnostics })
 }

package/validators/validate-model-attribute-exist.js

@@ -0,0 +1,128 @@
+const lsp = require('vscode-languageserver/node')
+
+/**
+ * Validate if a Waterline model attribute exists when used in criteria or chainable methods.
+ * @param {TextDocument} document - The text document to validate.
+ * @param {Object} typeMap - The type map containing models and their attributes.
+ * @returns {Array} diagnostics - Array of LSP diagnostics.
+ */
+module.exports = function validateModelAttributeExist(document, typeMap) {
+  const diagnostics = []
+  const text = document.getText()
+
+  // Criteria methods: Model.find({ attribute: ... }) etc.
+  const criteriaRegex =
+    /([A-Za-z0-9_]+)\s*\.\s*(find|findOne|update|destroy|where)\s*\(\s*\{\s*([A-Za-z0-9_]+)\s*:/g
+
+  // Chainable: .select(['attr1', 'attr2']) or .omit(['attr1', ...])
+  const arrayChainRegex = /\.(select|omit)\s*\(\s*\[([^\]]*)\]/g
+
+  // Chainable: .populate('attr')
+  const populateRegex = /\.populate\s*\(\s*['"]([A-Za-z0-9_]+)['"]\s*\)/g
+
+  let match
+
+  // Criteria methods
+  while ((match = criteriaRegex.exec(text)) !== null) {
+    const modelName = match[1]
+    const attribute = match[3]
+    const attrStart = match.index + match[0].lastIndexOf(attribute)
+    const attrEnd = attrStart + attribute.length
+
+    const model = typeMap.models && typeMap.models[modelName]
+    if (!model) continue
+
+    if (
+      !model.attributes ||
+      !Object.prototype.hasOwnProperty.call(model.attributes, attribute)
+    ) {
+      diagnostics.push(
+        lsp.Diagnostic.create(
+          lsp.Range.create(
+            document.positionAt(attrStart),
+            document.positionAt(attrEnd)
+          ),
+          `'${attribute}' is not a valid attribute of model '${modelName}'. Valid attributes: ${Object.keys(model.attributes || {}).join(', ')}`,
+          lsp.DiagnosticSeverity.Error,
+          'sails-lsp'
+        )
+      )
+    }
+  }
+
+  // .select(['attr1', ...]) and .omit(['attr1', ...])
+  while ((match = arrayChainRegex.exec(text)) !== null) {
+    const method = match[1]
+    const attrsString = match[2]
+    // Try to find the model name by searching backwards for ModelName.
+    // This is a heuristic and may not be perfect.
+    const before = text.slice(0, match.index)
+    const modelMatch = /([A-Za-z0-9_]+)\s*\.\s*$/.exec(
+      before.split('\n').pop() || ''
+    )
+    const modelName = modelMatch && modelMatch[1]
+    if (!modelName) continue
+    const model = typeMap.models && typeMap.models[modelName]
+    if (!model) continue
+
+    // Extract attribute names from the array string
+    const attrRegex = /['"]([A-Za-z0-9_]+)['"]/g
+    let attrMatch
+    while ((attrMatch = attrRegex.exec(attrsString)) !== null) {
+      const attribute = attrMatch[1]
+      const attrStart = match.index + match[0].indexOf(attribute)
+      const attrEnd = attrStart + attribute.length
+      if (
+        !model.attributes ||
+        !Object.prototype.hasOwnProperty.call(model.attributes, attribute)
+      ) {
+        diagnostics.push(
+          lsp.Diagnostic.create(
+            lsp.Range.create(
+              document.positionAt(attrStart),
+              document.positionAt(attrEnd)
+            ),
+            `'${attribute}' is not a valid attribute of model '${modelName}'. Valid attributes: ${Object.keys(model.attributes || {}).join(', ')}`,
+            lsp.DiagnosticSeverity.Error,
+            'sails-lsp'
+          )
+        )
+      }
+    }
+  }
+
+  // .populate('attr')
+  while ((match = populateRegex.exec(text)) !== null) {
+    const attribute = match[1]
+    // Try to find the model name by searching backwards for ModelName.
+    const before = text.slice(0, match.index)
+    const modelMatch = /([A-Za-z0-9_]+)\s*\.\s*$/.exec(
+      before.split('\n').pop() || ''
+    )
+    const modelName = modelMatch && modelMatch[1]
+    if (!modelName) continue
+    const model = typeMap.models && typeMap.models[modelName]
+    if (!model) continue
+
+    const attrStart = match.index + match[0].indexOf(attribute)
+    const attrEnd = attrStart + attribute.length
+    if (
+      !model.attributes ||
+      !Object.prototype.hasOwnProperty.call(model.attributes, attribute)
+    ) {
+      diagnostics.push(
+        lsp.Diagnostic.create(
+          lsp.Range.create(
+            document.positionAt(attrStart),
+            document.positionAt(attrEnd)
+          ),
+          `'${attribute}' is not a valid attribute of model '${modelName}'. Valid attributes: ${Object.keys(model.attributes || {}).join(', ')}`,
+          lsp.DiagnosticSeverity.Error,
+          'sails-lsp'
+        )
+      )
+    }
+  }
+
+  return diagnostics
+}

package/validators/validate-page-exist.js

@@ -0,0 +1,42 @@
+const lsp = require('vscode-languageserver/node')
+
+module.exports = function validatePageExist(document, typeMap) {
+  const diagnostics = []
+
+  const pages = extractPageReferences(document)
+  for (const { page, range } of pages) {
+    if (!typeMap.pages?.[page]) {
+      diagnostics.push(
+        lsp.Diagnostic.create(
+          range,
+          `Inertia page '${page}' not found. Make sure it exists under your /assets/js/pages directory.`,
+          lsp.DiagnosticSeverity.Error,
+          'sails-lsp'
+        )
+      )
+    }
+  }
+  return diagnostics
+}
+
+function extractPageReferences(document) {
+  const text = document.getText()
+  const regex = /\bpage\s*:\s*['"]([^'"]+)['"]/g
+  const pages = []
+
+  let match
+  while ((match = regex.exec(text)) !== null) {
+    const page = match[1]
+    const pageStart = match.index + match[0].indexOf(page)
+    const pageEnd = pageStart + page.length
+
+    pages.push({
+      page,
+      range: lsp.Range.create(
+        document.positionAt(pageStart),
+        document.positionAt(pageEnd)
+      )
+    })
+  }
+  return pages
+}

package/validators/validate-policy-exist.js

@@ -0,0 +1,45 @@
+const lsp = require('vscode-languageserver/node')
+
+module.exports = function validatePolicyExist(document, typeMap) {
+  const diagnostics = []
+  if (!document.uri.endsWith('policies.js')) return diagnostics
+
+  const policyRefs = extractPolicyReferences(document)
+  for (const { policy, range } of policyRefs) {
+    if (!typeMap.policies?.[policy]) {
+      diagnostics.push(
+        lsp.Diagnostic.create(
+          range,
+          `Policy '${policy}' not found. Make sure it exists in api/policies.`,
+          lsp.DiagnosticSeverity.Error,
+          'sails-lsp'
+        )
+      )
+    }
+  }
+
+  return diagnostics
+}
+
+function extractPolicyReferences(document) {
+  const text = document.getText()
+  const policyRegex = /(?::|=)\s*(?:\[\s*)?['"]([^'"]+)['"]/g
+  const policies = []
+
+  let match
+  while ((match = policyRegex.exec(text)) !== null) {
+    const policy = match[1]
+    const policyStart = match.index + match[0].indexOf(policy)
+    const policyEnd = policyStart + policy.length
+
+    policies.push({
+      policy,
+      range: lsp.Range.create(
+        document.positionAt(policyStart),
+        document.positionAt(policyEnd)
+      )
+    })
+  }
+
+  return policies
+}