package.json

{
  "name": "coc-pydocstring",
  "version": "0.10.0",
  "description": "doq (python docstring generator) extension for coc.nvim",
  "author": "yaegassy <yosstools@gmail.com>",
  "license": "MIT",
  "main": "lib/index.js",
  "keywords": [
    "coc.nvim",
    "python",
    "docstring",
    "vim",
    "neovim"
  ],
  "engines": {
    "coc": "^0.0.80"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/yaegassy/coc-pydocstring"
  },
  "scripts": {
    "lint": "eslint src --ext ts",
    "clean": "rimraf lib",
    "watch": "node esbuild.js --watch",
    "build": "node esbuild.js",
    "prepare": "node esbuild.js"
  },
  "prettier": {
    "singleQuote": true,
    "printWidth": 120,
    "semi": true
  },
  "devDependencies": {
    "@types/ini": "^1.3.31",
    "@types/node": "^18.17.3",
    "@types/rimraf": "^3.0.2",
    "@types/tmp": "^0.2.3",
    "@types/which": "^2.0.1",
    "@typescript-eslint/eslint-plugin": "^6.3.0",
    "@typescript-eslint/parser": "^6.3.0",
    "coc.nvim": "^0.0.81",
    "esbuild": "^0.16.17",
    "eslint": "^8.45.0",
    "eslint-config-prettier": "^8.8.0",
    "eslint-plugin-prettier": "^4.2.1",
    "prettier": "^2.8.8",
    "rimraf": "^3.0.2",
    "tmp": "^0.2.1",
    "typescript": "^5.1.6",
    "which": "^2.0.2"
  },
  "activationEvents": [
    "onLanguage:python"
  ],
  "contributes": {
    "rootPatterns": [
      {
        "filetype": "python",
        "patterns": [
          "setup.cfg",
          "pyproject.toml"
        ]
      }
    ],
    "configuration": {
      "type": "object",
      "title": "coc-pydocstring configuration",
      "properties": {
        "pydocstring.enable": {
          "type": "boolean",
          "default": true,
          "description": "Enable coc-pydocstring extension"
        },
        "pydocstring.doqPath": {
          "type": "string",
          "default": "",
          "description": "The path to the doq tool (Absolute path)"
        },
        "pydocstring.builtin.pythonPath": {
          "type": "string",
          "default": "",
          "description": "Python 3.x path (Absolute path) to be used for built-in install"
        },
        "pydocstring.enableInstallPrompt": {
          "type": "boolean",
          "default": true,
          "description": "Prompt the user before install"
        },
        "pydocstring.formatter": {
          "type": "string",
          "default": "sphinx",
          "enum": [
            "sphinx",
            "google",
            "numpy"
          ],
          "description": "Docstring formatter. sphinx, google or numpy"
        },
        "pydocstring.templatePath": {
          "type": "string",
          "default": "",
          "description": "Path to template directory. Settings starting with `/` are recognized as `absolute path`, while others are treated as `relative path` from the `workspace root`. Additionally, both `~` and `$HOME` are also available and will be expanded as `absolute path`"
        },
        "pydocstring.ignoreException": {
          "type": "boolean",
          "default": false,
          "description": "Ignore exception statements"
        },
        "pydocstring.ignoreYield": {
          "type": "boolean",
          "default": false,
          "description": "Ignore yield statements"
        },
        "pydocstring.ignoreInit": {
          "type": "boolean",
          "default": false,
          "description": "Ignore generate docstring to `__init__` method. This option only available at `:CocCommand pydocstring.runFile`"
        },
        "pydocstring.enableFileAction": {
          "type": "boolean",
          "default": false,
          "description": "Enable file-level code action"
        }
      }
    },
    "commands": [
      {
        "command": "pydocstring.install",
        "title": "Install doq"
      },
      {
        "command": "pydocstring.runFile",
        "title": "Run doq for file"
      },
      {
        "command": "pydocstring.showOutput",
        "title": "Show pydocstring output channel"
      }
    ]
  },
  "dependencies": {
    "ini": "^4.1.1",
    "toml": "^3.0.0"
  }
}