Skip to content

Commit b5bb8b3

Browse files
babakksbabakks
committed
fix: add godoclint to JSON schema
Signed-off-by: Babak K. Shandiz <[email protected]>
1 parent 0907a1d commit b5bb8b3

File tree

1 file changed

+197
-0
lines changed

1 file changed

+197
-0
lines changed

‎jsonschema/golangci.next.jsonschema.json‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -795,6 +795,7 @@
795795
"goconst",
796796
"gocritic",
797797
"gocyclo",
798+
"godoclint",
798799
"godot",
799800
"godox",
800801
"err113",
@@ -1848,6 +1849,199 @@
18481849
}
18491850
}
18501851
},
1852+
"godoclintSettings": {
1853+
"type": "object",
1854+
"properties": {
1855+
"include": {
1856+
"default": null,
1857+
"description": "List of regexp patterns matching relative paths to files the linter should include. Paths are forward-slash separated (Unix-style).",
1858+
"oneOf": [
1859+
{
1860+
"type": "array",
1861+
"uniqueItems": true,
1862+
"items": {
1863+
"type": "string"
1864+
}
1865+
},
1866+
{
1867+
"type": "null"
1868+
}
1869+
]
1870+
},
1871+
"exclude": {
1872+
"default": null,
1873+
"description": "List of regexp patterns matching relative paths to files the linter should skip. Paths are forward-slash separated (Unix-style).",
1874+
"oneOf": [
1875+
{
1876+
"type": "array",
1877+
"uniqueItems": true,
1878+
"items": {
1879+
"type": "string"
1880+
}
1881+
},
1882+
{
1883+
"type": "null"
1884+
}
1885+
]
1886+
},
1887+
"enable": {
1888+
"default": null,
1889+
"description": "List of rules to enable.",
1890+
"oneOf": [
1891+
{
1892+
"type": "array",
1893+
"uniqueItems": true,
1894+
"items": {
1895+
"type": "string",
1896+
"enum": [
1897+
"pkg-doc",
1898+
"single-pkg-doc",
1899+
"require-pkg-doc",
1900+
"start-with-name",
1901+
"require-doc",
1902+
"max-len",
1903+
"no-unused-link"
1904+
]
1905+
}
1906+
},
1907+
{
1908+
"type": "null"
1909+
}
1910+
]
1911+
},
1912+
"disable": {
1913+
"default": null,
1914+
"description": "List of rules to disable.",
1915+
"oneOf": [
1916+
{
1917+
"type": "array",
1918+
"uniqueItems": true,
1919+
"items": {
1920+
"type": "string",
1921+
"enum": [
1922+
"pkg-doc",
1923+
"single-pkg-doc",
1924+
"require-pkg-doc",
1925+
"start-with-name",
1926+
"require-doc",
1927+
"max-len",
1928+
"no-unused-link"
1929+
]
1930+
}
1931+
},
1932+
{
1933+
"type": "null"
1934+
}
1935+
]
1936+
},
1937+
"options": {
1938+
"type": "object",
1939+
"description": "A map for setting individual rule options.",
1940+
"properties": {
1941+
"max-len": {
1942+
"type": "object",
1943+
"properties": {
1944+
"length": {
1945+
"type": "integer",
1946+
"description": "Maximum line length for godocs, not including the `// `, or `/*` or `*/` tokens.",
1947+
"default": 77
1948+
},
1949+
"include-tests": {
1950+
"type": "boolean",
1951+
"description": "Include test files when applying the `max-len` rule.",
1952+
"default": false
1953+
}
1954+
}
1955+
},
1956+
"pkg-doc": {
1957+
"type": "object",
1958+
"properties": {
1959+
"start-with": {
1960+
"type": "string",
1961+
"description": "The start of a valid package godoc (e.g., \"Package <NAME>...\").",
1962+
"default": "Package"
1963+
},
1964+
"include-tests": {
1965+
"type": "boolean",
1966+
"description": "Include test files when applying the `pkg-doc` rule.",
1967+
"default": false
1968+
}
1969+
}
1970+
},
1971+
"single-pkg-doc": {
1972+
"type": "object",
1973+
"properties": {
1974+
"include-tests": {
1975+
"type": "boolean",
1976+
"description": "Include test files when applying the `single-pkg-doc` rule.",
1977+
"default": false
1978+
}
1979+
}
1980+
},
1981+
"require-pkg-doc": {
1982+
"type": "object",
1983+
"properties": {
1984+
"include-tests": {
1985+
"type": "boolean",
1986+
"description": "Include test files when applying the `require-pkg-doc` rule.",
1987+
"default": false
1988+
}
1989+
}
1990+
},
1991+
"require-doc": {
1992+
"type": "object",
1993+
"properties": {
1994+
"include-tests": {
1995+
"type": "boolean",
1996+
"description": "Include test files when applying the `require-doc` rule.",
1997+
"default": false
1998+
},
1999+
"ignore-exported": {
2000+
"type": "boolean",
2001+
"description": "Ignore exported (public) symbols when applying the `require-doc` rule.",
2002+
"default": false
2003+
},
2004+
"ignore-unexported": {
2005+
"type": "boolean",
2006+
"description": "Ignore unexported (private) symbols when applying the `require-doc` rule.",
2007+
"default": true
2008+
}
2009+
}
2010+
},
2011+
"start-with-name": {
2012+
"type": "object",
2013+
"properties": {
2014+
"include-tests": {
2015+
"type": "boolean",
2016+
"description": "Include test files when applying the `start-with-name` rule.",
2017+
"default": false
2018+
},
2019+
"include-unexported": {
2020+
"type": "boolean",
2021+
"description": "Include unexported symbols when applying the `start-with-name` rule.",
2022+
"default": false
2023+
},
2024+
"pattern": {
2025+
"type": "string",
2026+
"description": "Acceptable start pattern (regexp) for godoc starte when applying the `start-with-name` rule. The `%` placeholder is where the corresponding symbol name should should appear. An omitted placeholder means the symbol name should appear at the end of the pattern.",
2027+
"default": "((A|a|An|an|THE|The|the) )?%"
2028+
}
2029+
}
2030+
},
2031+
"no-unused-link": {
2032+
"type": "object",
2033+
"properties": {
2034+
"include-tests": {
2035+
"type": "boolean",
2036+
"description": "Include test files when applying the `no-unused-link` rule.",
2037+
"default": false
2038+
}
2039+
}
2040+
}
2041+
}
2042+
}
2043+
}
2044+
},
18512045
"godotSettings": {
18522046
"type": "object",
18532047
"additionalProperties": false,
@@ -4547,6 +4741,9 @@
45474741
"gocyclo": {
45484742
"$ref": "#/definitions/settings/definitions/gocycloSettings"
45494743
},
4744+
"godoclint": {
4745+
"$ref": "#/definitions/settings/definitions/godoclintSettings"
4746+
},
45504747
"godot": {
45514748
"$ref": "#/definitions/settings/definitions/godotSettings"
45524749
},

0 commit comments

Comments
 (0)