ocomment 0.1.0

Fast, byte-preserving comment checker and remover
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://ocomment.dev/schema/config-v1.json",
  "title": "OComment configuration v1",
  "type": "object",
  "additionalProperties": false,
  "required": ["version"],
  "properties": {
    "version": { "const": 1 },
    "files": {
      "type": "object", "additionalProperties": false,
      "properties": {
        "max_size": { "type": "integer", "minimum": 1, "default": 33554432 },
        "hidden": { "type": "boolean", "default": false },
        "follow_symlinks": { "type": "boolean", "default": false },
        "ignore": { "type": "boolean", "default": true },
        "include": { "$ref": "#/$defs/strings" },
        "exclude": { "$ref": "#/$defs/strings" }
      }
    },
    "policy": {
      "type": "object", "additionalProperties": false,
      "properties": {
        "mode": { "$ref": "#/$defs/policy" },
        "layout": { "enum": ["lines", "columns", "compact"], "default": "lines" },
        "keep_kind": { "$ref": "#/$defs/kinds" },
        "remove_kind": { "$ref": "#/$defs/kinds" },
        "keep_regex": { "$ref": "#/$defs/strings" },
        "remove_regex": { "$ref": "#/$defs/strings" },
        "force_invalid": { "type": "boolean", "default": false },
        "force_protected": { "type": "boolean", "default": false }
      }
    },
    "git": {
      "type": "object", "additionalProperties": false,
      "properties": { "staged": { "type": "boolean" }, "index_only": { "type": "boolean" } }
    },
    "lsp": {
      "type": "object", "additionalProperties": false,
      "properties": {
        "on_save": { "type": "boolean", "default": false },
        "diagnostics": { "type": "boolean", "default": true },
        "code_lens": { "type": "boolean", "default": true }
      }
    },
    "languages": {
      "type": "object", "additionalProperties": { "$ref": "#/$defs/languageConfig" }
    },
    "profiles": {
      "type": "object", "additionalProperties": { "$ref": "#/$defs/profile" }
    },
    "plugins": {
      "type": "object", "additionalProperties": false,
      "properties": {
        "enabled": { "$ref": "#/$defs/strings" },
        "routes": {
          "type": "object",
          "additionalProperties": { "type": "string", "minLength": 1 },
          "default": {}
        },
        "memory_mib": { "type": "integer", "minimum": 1, "maximum": 4096 },
        "instances": { "type": "integer", "minimum": 1, "maximum": 1024 },
        "fuel_per_byte": { "type": "integer", "minimum": 1, "maximum": 1000000 }
      }
    },
    "overrides": {
      "type": "array", "items": { "$ref": "#/$defs/pathOverride" }
    }
  },
  "$defs": {
    "strings": { "type": "array", "items": { "type": "string" }, "default": [] },
    "policy": { "enum": ["safe", "legal", "all"], "default": "safe" },
    "language": { "enum": ["rust", "ocaml", "c", "cpp", "go", "java", "javascript", "typescript", "python", "shell", "html", "css", "jsonc", "sql", "kotlin", "toml", "lua", "yaml", "php", "ruby", "zig", "r", "dart", "swift", "csharp", "scala", "vue", "svelte", "markdown", "perl"] },
    "kind": { "enum": ["line", "block", "doc-line", "doc-block", "directive", "license", "html-comment", "shebang", "encoding", "optimizer-hint", "version-comment"] },
    "kinds": { "type": "array", "items": { "$ref": "#/$defs/kind" }, "default": [] },
    "languageConfig": {
      "type": "object", "additionalProperties": false,
      "properties": {
        "enabled": { "type": "boolean" }, "dialect": { "$ref": "#/$defs/dialect" },
        "policy": { "$ref": "#/$defs/policy" }, "layout": { "enum": ["lines", "columns", "compact"] },
        "keep_kind": { "$ref": "#/$defs/kinds" }, "remove_kind": { "$ref": "#/$defs/kinds" },
        "keep_regex": { "$ref": "#/$defs/strings" }, "remove_regex": { "$ref": "#/$defs/strings" }
      }
    },
    "pathOverride": {
      "type": "object", "additionalProperties": false, "required": ["paths"],
      "properties": {
        "paths": { "$ref": "#/$defs/nonEmptyStrings" },
        "language": { "$ref": "#/$defs/language" },
        "dialect": { "$ref": "#/$defs/dialect" },
        "policy": { "$ref": "#/$defs/policy" },
        "layout": { "enum": ["lines", "columns", "compact"] },
        "keep_kind": { "$ref": "#/$defs/kinds" },
        "remove_kind": { "$ref": "#/$defs/kinds" },
        "keep_regex": { "$ref": "#/$defs/strings" },
        "remove_regex": { "$ref": "#/$defs/strings" }
      }
    },
    "dialect": {
      "enum": ["standard", "jsx", "tsx", "objective-c", "objective-cpp", "gnu-c", "gnu-cpp", "cuda", "posix-sh", "bash53", "zsh", "postgresql", "mysql", "sqlite", "t-sql", "oracle", "scss", "sass"]
    },
    "nonEmptyStrings": {
      "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 }
    },
    "profile": {
      "type": "object", "additionalProperties": false,
      "anyOf": [
        { "required": ["line_comments"], "properties": { "line_comments": { "minItems": 1 } } },
        { "required": ["block_comments"], "properties": { "block_comments": { "minItems": 1 } } }
      ],
      "properties": {
        "name": { "type": "string", "minLength": 1 }, "extensions": { "$ref": "#/$defs/strings" },
        "line_comments": { "type": "array", "items": { "$ref": "#/$defs/lineDelimiter" } },
        "block_comments": { "type": "array", "items": { "$ref": "#/$defs/blockDelimiter" } },
        "strings": { "type": "array", "items": { "$ref": "#/$defs/stringDelimiter" } },
        "protected_patterns": { "type": "array", "items": { "$ref": "#/$defs/protectedPattern" } }
      }
    },
    "lineDelimiter": {
      "type": "object", "additionalProperties": false, "required": ["start"],
      "properties": {
        "start": { "type": "string", "minLength": 1 },
        "requires_boundary": { "type": "boolean", "default": false },
        "kind": { "$ref": "#/$defs/kind" }
      }
    },
    "blockDelimiter": {
      "type": "object", "additionalProperties": false, "required": ["start", "end"],
      "properties": {
        "start": { "type": "string", "minLength": 1 },
        "end": { "type": "string", "minLength": 1 },
        "nested": { "type": "boolean", "default": false },
        "kind": { "$ref": "#/$defs/kind" }
      }
    },
    "stringDelimiter": {
      "type": "object", "additionalProperties": false, "required": ["start", "end"],
      "properties": {
        "start": { "type": "string", "minLength": 1 },
        "end": { "type": "string", "minLength": 1 },
        "escape": { "type": "string", "minLength": 1 },
        "multiline": { "type": "boolean", "default": false }
      }
    },
    "protectedPattern": {
      "type": "object", "additionalProperties": false, "required": ["contains", "reason"],
      "properties": {
        "contains": { "type": "string", "minLength": 1 },
        "reason": { "type": "string", "minLength": 1 }
      }
    }
  }
}