rustdocstring/package.json at master · chrisdbeard/rustdocstring · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
{
  "name": "rustdocstring",
  "displayName": "Rust Doc String - Rust Docstring Generator",
  "description": "Automatically generate structured Rust doc comments (///) for functions, structs, and enums.",
  "version": "0.1.3",
  "publisher": "ChrisBeard",
  "author": "Chris Beard",
  "icon": "images/icon2.png",
  "engines": {
    "vscode": "^1.80.0"
  },
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "https://github.com/chrisdbeard/rustdocstring"
  },
  "bugs": {
    "url": "https://github.com/chrisdbeard/rustdocstring/issues"
  },
  "categories": [
    "Programming Languages",
    "Snippets",
    "Formatters"
  ],
  "keywords": [
    "rust",
    "docstring",
    "documentation",
    "comment",
    "generate",
    "generator",
    "///",
    "vscode-extension",
    "vscode",
    "docgen",
    "autodocstring",
    "keybindings",
    "rustdocstring",
    "autodocgen",
    "auto",
    "doc",
    "block"
  ],
  "activationEvents": [
    "onLanguage:rust"
  ],
  "main": "./src/extension.js",
  "contributes": {
    "languages": [
      {
        "id": "rust",
        "extensions": [
          ".rs"
        ],
        "aliases": [
          "Rust"
        ]
      }
    ],
    "configuration": {
      "title": "Rust Doc String Generator",
      "properties": {
        "rustdocstring.includeExamples": {
          "type": "boolean",
          "default": true,
          "description": "Include the '# Examples' section in generated Rust documentation."
        },
        "rustdocstring.examplesOnlyForPublicOrExtern": {
          "type": "boolean",
          "default": false,
          "description": "Only include examples for functions marked 'pub' or 'extern'.",
          "markdownDescription": "This applies only if `includeExamples` is enabled."
        },
        "rustdocstring.includeSafetyDetails": {
          "type": "boolean",
          "default": false,
          "description": "Include extended detailed safety requirments in the '# Safety' section for unsafe or extern functions."
        }
      }
    }
  },
  "scripts": {
    "lint": "eslint .",
    "pretest": "npm run lint",
    "test": "mocha \"./src/test/*.test.js\""
  },
  "devDependencies": {
    "@types/mocha": "^10.0.10",
    "@types/node": "22.15.3",
    "@types/vscode": "^1.80.0",
    "@vscode/test-cli": "^0.0.10",
    "@vscode/test-electron": "^2.5.2",
    "eslint": "^9.25.1",
    "mocha": "^11.2.2",
    "standard-version": "^9.5.0"
  }
}