package.json

{
  "name": "semantic-models",
  "displayName": "Semantic Models",
  "description": "Support for RDF/Turtle documents, including SAMM Aspect Models",
  "version": "0.0.1",
  "publisher": "eclipse-esmf",
  "icon": "media/esmf-logo.png",
  "license": "MPL-2.0",
  "repository": {
    "type": "git",
    "url": "https://github.com/eclipse-esmf/esmf-vs-code-plugin.git"
  },
  "bugs": {
    "url": "https://github.com/eclipse-esmf/esmf-vs-code-plugin/issues"
  },
  "engines": {
    "vscode": "^1.110.0"
  },
  "categories": [
    "Other"
  ],
  "main": "./out/extension.js",
  "activationEvents": [
    "onLanguage:turtle"
  ],
  "contributes": {
    "commands": [
      {
        "command": "semantic-models.validateDocumentNow",
        "title": "Validate Document Now",
        "category": "Semantic Models"
      },
      {
        "command": "semantic-models.restartLanguageServices",
        "title": "Restart Language Server Connection",
        "category": "Semantic Models"
      },
      {
        "command": "semantic-models.selectSammCliExecutable",
        "title": "Select SAMM CLI Executable",
        "category": "Semantic Models"
      }
    ],
    "languages": [
      {
        "id": "turtle",
        "aliases": [
          "Turtle",
          "turtle",
          "RDF/Turtle"
        ],
        "extensions": [
          ".ttl"
        ],
        "configuration": "./language-configuration.json"
      }
    ],
    "configuration": {
      "title": "Semantic Models",
      "type": "object",
      "description": "Configuration settings for the Semantic Models extension.",
      "properties": {
        "semantic-models.languageServerSettings.activateEmbeddedLanguageServer": {
          "type": "boolean",
          "default": true,
          "description": "When enabled, the extension starts the SAMM language server using the executable configured below. When disabled, an external language server must be started manually.",
          "order": 0
        },
        "semantic-models.languageServerSettings.automaticUpdateCheck": {
          "type": "boolean",
          "default": true,
          "description": "Automatically check for updates to the SAMM language server and notify when a new version is available.",
          "order": 1
        },
        "semantic-models.languageServerSettings.sammCliPath": {
          "type": "string",
          "default": "",
          "description": "Path to the SAMM CLI executable or JAR file to use as the language server. Can be downloaded or selected using the 'Select SAMM CLI Executable' command.",
          "order": 2
        },
        "semantic-models.languageServerSettings.serverPort": {
          "type": "number",
          "default": 1846,
          "description": "TCP port used to connect to the SAMM language server.",
          "order": 3
        },
        "semantic-models.languageServerSettings.traceLevel": {
          "type": "string",
          "enum": [
            "off",
            "messages",
            "verbose"
          ],
          "enumDescriptions": [
            "No tracing.",
            "Log request/response message names.",
            "Log full message contents."
          ],
          "default": "off",
          "description": "Controls the verbosity of Language Server Protocol (LSP) tracing in the output channel.",
          "order": 4
        },
        "semantic-models.modelResolution.githubRepositories": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "repository": {
                "type": "string",
                "default": "",
                "pattern": "^[A-Za-z0-9_.-]+/[A-Za-z0-9_.-]+$",
                "patternErrorMessage": "Must be in the format \"owner/repository\".",
                "markdownDescription": "GitHub repository to use for Aspect Model Resolution. Format: `owner/repository`. Example: `eclipse-esmf/esmf-sdk`."
              },
              "branch": {
                "type": "string",
                "default": "main",
                "description": "Branch to resolve Aspect Models from. Must not be set together with \"tag\"."
              },
              "tag": {
                "type": "string",
                "default": "",
                "description": "Tag to resolve Aspect Models from. Must not be set together with \"branch\"."
              },
              "path": {
                "type": "string",
                "default": "/",
                "description": "Path inside the repository under which Aspect Models are located."
              },
              "token": {
                "type": "string",
                "default": "",
                "description": "GitHub token used for authentication when accessing this repository. If not provided, the repository will be accessed anonymously."
              }
            },
            "required": [
              "repository"
            ],
            "additionalProperties": false
          },
          "default": [],
          "markdownDescription": "Additional GitHub repositories to be used for Aspect Model Resolution. Enables e.g. go to Definition and validation of models that reference Aspect Models in other repositories. Each entry must specify the repository in the format `owner/repository`, and may optionally specify a branch/tag, path, and GitHub token for authentication.",
          "order": 5
        }
      }
    },
    "configurationDefaults": {
      "[turtle]": {
        "editor.semanticHighlighting.enabled": true
      }
    },
    "menus": {
      "editor/context": [
        {
          "command": "semantic-models.validateDocumentNow",
          "when": "resourceLangId == turtle",
          "group": "1_modification"
        }
      ]
    },
    "walkthroughs": [
      {
        "id": "semantic-models-getting-started",
        "title": "Getting Started with the Semantic Models Extension",
        "description": "Learn how to use the Semantic Models extension to edit and validate your RDF/Turtle files, including SAMM Aspect Models.\nThis walkthrough will guide you through the key features of the extension, including validating your RDF/Turtle files and SAMM Aspect Models using the integrated language server.",
        "steps": [
          {
            "id": "select-samm-cli",
            "title": "Select a SAMM CLI Executable",
            "description": "Complete the initial setup by downloading or selecting a SAMM CLI executable, which provides the required SAMM Language Server.\n[Download or Select SAMM CLI](command:turtle.selectSammCliExecutable)",
            "media": {
              "image": "media/walkthrough_select_samm_cli.png",
              "altText": "Example of selecting a SAMM CLI executable"
            }
          },
          {
            "id": "validation",
            "title": "Validating RDF/Turtle Files and SAMM Aspect Models",
            "description": "To validate an RDF/Turtle file or a SAMM Aspect Model, simply open it in VS Code. The extension will automatically connect to the language server and display any validation issues in the Problems view. You can also trigger validation manually using the 'Validate Document Now' command from the Command Palette.",
            "media": {
              "image": "media/walkthrough_validation.png",
              "altText": "Example of validation issues shown in the Problems panel"
            }
          }
        ]
      }
    ]
  },
  "scripts": {
    "vscode:prepublish": "npm run build",
    "watch": "tsc -watch -p ./",
    "pretest": "npm run build && npm run lint",
    "build": "tsc -p tsconfig.json",
    "build-watch": "tsc -p tsconfig.json --watch",
    "prettier": "prettier --config .prettierrc --write './src/**/*{.ts,.js,.json}'",
    "test": "vscode-test --config .vscode-test.mjs",
    "test:prettier": "prettier --config .prettierrc --list-different './src/**/*{.ts,.js,.json}'",
    "test:coverage": "vscode-test --config .vscode-test.mjs --coverage --coverage-reporter text --coverage-reporter lcov",
    "lint": "eslint src --ext .ts",
    "lint:fix": "eslint src --ext .ts --fix"
  },
  "devDependencies": {
    "@types/jest": "^30.0.0",
    "@types/node": "22.x",
    "@types/vscode": "^1.110.0",
    "@vscode/test-cli": "^0.0.12",
    "@vscode/test-electron": "^2.5.2",
    "eslint": "^9.39.3",
    "typescript": "^5.9.3",
    "typescript-eslint": "^8.56.1"
  },
  "dependencies": {
    "extract-zip": "^2.0.1",
    "tar": "^7.5.15",
    "vscode-languageclient": "^9.0.1"
  }
}