package.json

{
  "name": "sphinx-needs-vscode",
  "displayName": "Sphinx-Needs",
  "description": "Sphinx-Needs language support in VSCode",
  "author": {
    "name": "team useblocks"
  },
  "publisher": "useblocks",
  "version": "0.3.2",
  "license": "MIT",
  "icon": "utils/sn-favicon.png",
  "repository": {
    "type": "git",
    "url": "https://github.com/useblocks/sphinx-needs-vscode"
  },
  "homepage": "https://sphinx-needs-vscode.useblocks.com/",
  "engines": {
    "vscode": "^1.67.0"
  },
  "categories": [],
  "activationEvents": [
    "workspaceContains:conf.py",
    "workspaceContains:*/conf.py",
    "workspaceContains:*/*/conf.py",
    "onView:sphinxNeedsExplorer"
  ],
  "main": "./dist/extension.js",
  "capabilities": {},
  "contributes": {
    "viewsContainers": {
      "activitybar": [
        {
          "id": "sphinx-needs",
          "title": "Sphinx-Needs",
          "icon": "utils/sphinx-needs-logo-favicon.png"
        }
      ]
    },
    "viewsWelcome": [
      {
        "view": "sphinxNeedsExplorer",
        "contents": "Sphinx-Needs NeedsTree View.\n"
      },
      {
        "view": "sphinxNeedsHelp",
        "contents": "Sphinx-Needs Help View.\n"
      }
    ],
    "views": {
      "explorer": [
        {
          "id": "sphinxNeedsCurrent",
          "name": "Sphinx-Needs Current"
        }
      ],
      "sphinx-needs": [
        {
          "id": "sphinxNeedsExplorer",
          "name": "Explorer",
          "contextualTitle": "Explorer"
        },
        {
          "id": "sphinxNeedsHelp",
          "name": "Help",
          "contextualTitle": "Help"
        }
      ]
    },
    "commands": [
      {
        "command": "sphinxNeedsExplorer.gotoDef",
        "title": "Goto Definition",
        "icon": "$(location)"
      },
      {
        "command": "sphinxNeedsExplorer.openNeedsJson",
        "title": "Open NeedsJson",
        "icon": "$(file)"
      },
      {
        "command": "sphinxNeedsExplorer.openSettings",
        "title": "Open Settings",
        "icon": "$(settings-gear)"
      },
      {
        "command": "sphinxNeedsExplorer.openSphinxNeedsOfficialDocs",
        "title": "Open Sphinx-Needs Official Docs",
        "icon": "$(browser)"
      },
      {
        "command": "sphinxNeedsExplorer.copyID",
        "title": "Copy Need ID",
        "icon": "$(briefcase)"
      },
      {
        "command": "sphinxNeedsHelp.openUrl",
        "title": "Open Url"
      }
    ],
    "menus": {
      "view/title": [
        {
          "command": "sphinxNeedsExplorer.openNeedsJson",
          "when": "view == sphinxNeedsExplorer",
          "group": "navigation"
        },
        {
          "command": "sphinxNeedsExplorer.openSettings",
          "when": "view == sphinxNeedsExplorer",
          "group": "navigation"
        },
        {
          "command": "sphinxNeedsExplorer.openSphinxNeedsOfficialDocs",
          "when": "view == sphinxNeedsExplorer",
          "group": "navigation"
        }
      ],
      "view/item/context": [
        {
          "command": "sphinxNeedsExplorer.gotoDef",
          "when": "view == sphinxNeedsExplorer && viewItem == needID",
          "group": "inline"
        },
        {
          "command": "sphinxNeedsExplorer.copyID",
          "when": "view == sphinxNeedsExplorer && viewItem == needID",
          "group": "inline"
        }
      ]
    },
    "configuration": {
      "type": "object",
      "title": "Sphinx-Needs",
      "properties": {
        "sphinx-needs.trace.server": {
          "scope": "window",
          "type": "string",
          "enum": [
            "off",
            "messages",
            "verbose"
          ],
          "default": "off",
          "description": "Trace the communication between VSCode and Sphinx-Needs language server."
        },
        "sphinx-needs.needsJson": {
          "type": "string",
          "scope": "resource",
          "default": "",
          "markdownDescription": "File path of the generated Sphinx-Need JSON file. \n\n Sphinx-Needs docs: [needs.json Builder](https://sphinx-needs.readthedocs.io/en/latest/builders.html#needs), ['needs_build_json' config option](https://sphinx-needs.readthedocs.io/en/latest/configuration.html#needs-build-json)"
        },
        "sphinx-needs.srcDir": {
          "type": "string",
          "scope": "resource",
          "default": "",
          "description": "Sphinx-Needs docs source directory."
        },
        "sphinx-needs.folders": {
          "type":"array",
          "scope": "resource",
          "items": {
            "type": "object",
            "properties": {
              "needsJson": {
                "type":"string"
              },
              "srcDir": {
                "type":"string"
              }
            }
          },
          "default": [],
          "description": "Specify needsJson and srcDir path for multiple Sphinx-Needs docs under one workspace."
        },
        "sphinx-needs.activateFiles": {
          "type": "array",
          "scope": "resource",
          "items": {
            "type": "string"
          },
          "default": [
            "restructuredtext",
            "python"
          ],
          "markdownDescription": "Activate Sphinx-Needs support for [official language identifiers](https://code.visualstudio.com/docs/languages/identifiers#_known-language-identifiers)"
        },
        "sphinx-needs.explorerOptions":{
          "type": "array",
          "scope": "resource",
          "items": {
            "type": "string"
          },
          "default": ["status", "links", "tags"],
          "description": "Sphinx-Needs need options to be shown under tree view of Sphinx-Needs Explorer."
        },
        "sphinx-needs.explorerItemHoverOptions": {
          "type": "array",
          "scope": "resource",
          "items": {
            "type": "string"
          },
          "default": ["tags"],
          "description": "Sphinx-Needs need options to be shown when hover over tree item in Sphinx-Needs Explorer."
        },
        "sphinx-needs.loggingLevel": {
          "type": "string",
          "scope": "resource",
          "enum": ["off", "error", "warn", "info", "debug", "verbose"],
          "default": "warn",
          "description": "Specify logging level of this extension, default is: 'warn'."
        }
      }
    }
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "compile": "tsc -b && npm run bundle",
    "test-compile": "tsc -p ./",
    "bundle": "esbuild client/src/extension.ts --bundle --outdir=dist --external:vscode --format=cjs --platform=node",
    "bundle-dev": "npm run bundle -- --sourcemap",
    "bundle-watch": "npm run bundle -- --sourcemap --watch",
    "test": "npm run test-compile && node ./client/out/test/runTest.js",
    "watch": "tsc -b -w",
    "postinstall": "cd client && npm install && cd ../server && npm install && cd ..",
    "lint": "gts lint ./client/src ./server/src",
    "clean": "gts clean && cd client && gts clean && cd ../server && gts clean && cd ..",
    "fix-lint": "gts fix ./client/src ./server/src"
  },
  "devDependencies": {
    "@types/glob": "8.0.0",
    "@types/mocha": "^9.1.0",
    "@types/node": "^16.11.7",
    "esbuild": "^0.15.16",
    "gts": "^3.1.1",
    "mocha": "^9.2.1",
    "typescript": "^4.9.3"
  }
}