wikilint 2.47.0 → 2.48.1

package/README.md

@@ -97,6 +97,6 @@ repos:
         # You can add any CLI options as needed
         entry: wikilint
         language: node
-        additional_dependencies: ['wikilint@2.47.0']
+        additional_dependencies: ['wikilint@2.48.1']
         files: \.(mediawiki|wiki|wikitext)$
 ```

package/config/.schema.json

@@ -1,5 +1,5 @@
 {
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "https://json-schema.org/draft/2020-12/schema",
 	"type": "object",
 	"properties": {
 		"ext": {

package/config/default.json

@@ -1023,6 +1023,7 @@
 			"DEFAULTSORT": "defaultsort",
 			"DEFAULTSORTKEY": "defaultsort",
 			"DEFAULTCATEGORYSORT": "defaultsort",
+			"CATEGORYSORT": "categorysort",
 			"分类中页面数": "pagesincategory",
 			"カテゴリ内ページ数": "pagesincategory",
 			"PAGESINCATEGORY": "pagesincategory",

package/config/enwiki.json

@@ -456,6 +456,7 @@
 			"DEFAULTSORT": "defaultsort",
 			"DEFAULTSORTKEY": "defaultsort",
 			"DEFAULTCATEGORYSORT": "defaultsort",
+			"CATEGORYSORT": "categorysort",
 			"PAGESINCATEGORY": "pagesincategory",
 			"PAGESINCAT": "pagesincategory",
 			"PAGESIZE": "pagesize",

package/config/jawiki.json

@@ -546,6 +546,7 @@
 			"DEFAULTSORT": "defaultsort",
 			"DEFAULTSORTKEY": "defaultsort",
 			"DEFAULTCATEGORYSORT": "defaultsort",
+			"CATEGORYSORT": "categorysort",
 			"カテゴリ内ページ数": "pagesincategory",
 			"PAGESINCATEGORY": "pagesincategory",
 			"PAGESINCAT": "pagesincategory",

package/config/zhwiki.json

@@ -682,6 +682,7 @@
 			"默认排序": "defaultsort",
 			"默认排序关键字": "defaultsort",
 			"默认分类排序": "defaultsort",
+			"CATEGORYSORT": "categorysort",
 			"PAGESINCATEGORY": "pagesincategory",
 			"PAGESINCAT": "pagesincategory",
 			"分类中页面数": "pagesincategory",

package/data/signatures.json

@@ -2158,6 +2158,26 @@
 			],
 			"description": "Used for categorizing pages, sets a default [category sort key](https://www.mediawiki.org/wiki/Help:Categories). It can take a second argument of *noerror* or *noreplace* to suppress error messages when multiple defaultsortkeys are used on one page or to make this `defaultsort` do nothing if a `defaultsort` was already specified earlier in the page."
 		},
+		{
+			"aliases": [
+				"categorysort"
+			],
+			"signatures": [
+				[
+					{
+						"label": "TIMESTAMP",
+						"const": true
+					}
+				],
+				[
+					{
+						"label": "RTIMESTAMP",
+						"const": true
+					}
+				]
+			],
+			"description": "When placed on a category page, the category will be sorted based on timestamp of categorization. `{{CATEGORYSORT:TIMESTAMP}}` lists members by the time they were added to the category, oldest first, and `{{CATEGORYSORT:RTIMESTAMP}}` lists the most recently added members first. Readers can still override this with the `cldsort` URL parameter, and the new `cldorder=desc` URL parameter reverses a `cldsort=timestamp` listing."
+		},
 		{
 			"aliases": [
 				"numberofpages"

package/dist/base.d.mts

@@ -2,7 +2,7 @@ import type { Range, Position, ColorInformation, ColorPresentation, CompletionIt
 export interface Config {
     ext: string[];
     readonly html: [string[], string[], string[]];
-    readonly namespaces: Record<string, string>;
+    readonly namespaces: Record<number, string>;
     readonly nsid: Record<string, number>;
     readonly parserFunction: [Record<string, string>, Record<string, string>, string[], string[]];
     readonly doubleUnderscore: [string[], string[], Record<string, string>, Record<string, string>];
@@ -117,6 +117,7 @@ export type CompletionItem = Omit<CompletionItemBase, 'kind'> & {
     kind?: CompletionItemKind | keyof typeof CompletionItemKind;
 };
 export interface LanguageService {
+    /** @since v1.17.1 */
     include: boolean;
     /**
      * Destroy the instance
@@ -147,6 +148,14 @@ export interface LanguageService {
      * @param position position / 位置
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
+    /**
+     * Add additional information to a completion item
+     *
+     * 为自动补全项添加额外信息
+     * @param item completion item / 自动补全项
+     * @since v1.48.0
+     */
+    resolveCompletionItem(item: CompletionItem): CompletionItem;
     /**
      * Provide grammar check
      *
@@ -160,6 +169,7 @@ export interface LanguageService {
      *
      * 实现修复全部代码的操作
      * @param action code action / 代码操作
+     * @since v1.24.1
      */
     resolveCodeAction(action: CodeAction): CodeAction;
     /**
@@ -182,6 +192,7 @@ export interface LanguageService {
      * 提供文档高亮
      * @param text source Wikitext / 源代码
      * @param position position / 位置
+     * @since v1.46.1
      */
     provideDocumentHighlights(text: string, position: Position): Promise<DocumentHighlight[] | undefined>;
     /**
@@ -238,6 +249,7 @@ export interface LanguageService {
      *
      * 提供 CodeLens
      * @param text source Wikitext / 源代码
+     * @since v1.16.3
      */
     provideInlayHints(text: string): Promise<InlayHint[]>;
     /**
@@ -246,6 +258,7 @@ export interface LanguageService {
      * 提供重构操作
      * @param text source Wikitext / 源代码
      * @param range range of the refactoring / 重构范围
+     * @since v1.24.1
      */
     provideRefactoringAction(text: string, range?: Range): Promise<CodeAction[]>;
     /**
@@ -268,6 +281,7 @@ export interface LanguageService {
      * 设置目标维基百科
      * @param wiki Wikipedia URL / 维基百科网址
      * @param user URI for wiki userpage or email address of the user / 维基用户页面地址或用户的电子邮件地址
+     * @since v1.18.1
      */
     setTargetWikipedia(wiki: string, user: string): Promise<void>;
     [Symbol.dispose](): void;
@@ -302,6 +316,7 @@ export interface Parser {
      *
      * 获取当前的解析设置
      * @param config unprocessed parser configuration / 未处理的解析设置
+     * @throws `RangeError` if the configuration file path or file name is invalid
      */
     getConfig(config?: ConfigData): Config;
     /**

package/dist/base.d.ts

@@ -2,7 +2,7 @@ import type { Range, Position, ColorInformation, ColorPresentation, CompletionIt
 export interface Config {
     ext: string[];
     readonly html: [string[], string[], string[]];
-    readonly namespaces: Record<string, string>;
+    readonly namespaces: Record<number, string>;
     readonly nsid: Record<string, number>;
     readonly parserFunction: [Record<string, string>, Record<string, string>, string[], string[]];
     readonly doubleUnderscore: [string[], string[], Record<string, string>, Record<string, string>];
@@ -117,6 +117,7 @@ export type CompletionItem = Omit<CompletionItemBase, 'kind'> & {
     kind?: CompletionItemKind | keyof typeof CompletionItemKind;
 };
 export interface LanguageService {
+    /** @since v1.17.1 */
     include: boolean;
     /**
      * Destroy the instance
@@ -147,6 +148,14 @@ export interface LanguageService {
      * @param position position / 位置
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
+    /**
+     * Add additional information to a completion item
+     *
+     * 为自动补全项添加额外信息
+     * @param item completion item / 自动补全项
+     * @since v1.48.0
+     */
+    resolveCompletionItem(item: CompletionItem): CompletionItem;
     /**
      * Provide grammar check
      *
@@ -160,6 +169,7 @@ export interface LanguageService {
      *
      * 实现修复全部代码的操作
      * @param action code action / 代码操作
+     * @since v1.24.1
      */
     resolveCodeAction(action: CodeAction): CodeAction;
     /**
@@ -182,6 +192,7 @@ export interface LanguageService {
      * 提供文档高亮
      * @param text source Wikitext / 源代码
      * @param position position / 位置
+     * @since v1.46.1
      */
     provideDocumentHighlights(text: string, position: Position): Promise<DocumentHighlight[] | undefined>;
     /**
@@ -238,6 +249,7 @@ export interface LanguageService {
      *
      * 提供 CodeLens
      * @param text source Wikitext / 源代码
+     * @since v1.16.3
      */
     provideInlayHints(text: string): Promise<InlayHint[]>;
     /**
@@ -246,6 +258,7 @@ export interface LanguageService {
      * 提供重构操作
      * @param text source Wikitext / 源代码
      * @param range range of the refactoring / 重构范围
+     * @since v1.24.1
      */
     provideRefactoringAction(text: string, range?: Range): Promise<CodeAction[]>;
     /**
@@ -268,6 +281,7 @@ export interface LanguageService {
      * 设置目标维基百科
      * @param wiki Wikipedia URL / 维基百科网址
      * @param user URI for wiki userpage or email address of the user / 维基用户页面地址或用户的电子邮件地址
+     * @since v1.18.1
      */
     setTargetWikipedia(wiki: string, user: string): Promise<void>;
     [Symbol.dispose](): void;
@@ -302,6 +316,7 @@ export interface Parser {
      *
      * 获取当前的解析设置
      * @param config unprocessed parser configuration / 未处理的解析设置
+     * @throws `RangeError` if the configuration file path or file name is invalid
      */
     getConfig(config?: ConfigData): Config;
     /**

package/dist/bin/cli.js

@@ -285,11 +285,10 @@ if (recursive) {
         if (!fs_1.default.existsSync(file)) {
             return [];
         }
-        if (fs_1.default.statSync(file).isFile()) {
-            return file;
-        }
-        return fs_1.default.readdirSync(file, { recursive: true, withFileTypes: true }).filter(dir => dir.isFile())
-            .map(dir => path_1.default.join(dir.parentPath, dir.name));
+        return fs_1.default.statSync(file).isFile()
+            ? file
+            : fs_1.default.readdirSync(file, { recursive: true, withFileTypes: true }).filter(dir => dir.isFile())
+                .map(dir => path_1.default.join(dir.parentPath, dir.name));
     });
 }
 if (exts.length > 0) {
@@ -405,9 +404,9 @@ const { mtimeMs } = fs_1.default.statSync(config), obj = cache?.[include ? 'incl
         exiting ||= Boolean(nLocalErr || strict && nLocalWarn);
     }
     if (nErr || nWarn) {
-        console.error(styleText(['red', 'bold'], '%s'), `\n✖ ${plural(nErr + nWarn, 'problem')} (${plural(nErr, 'error')}, ${plural(nWarn, 'warning')})`);
+        console.error(styleText(['red', 'bold'], '\n✖ %s (%s, %s)'), plural(nErr + nWarn, 'problem'), plural(nErr, 'error'), plural(nWarn, 'warning'));
         if (nFixableErr || nFixableWarn) {
-            console.error(styleText(['red', 'bold'], '%s'), `  ${plural(nFixableErr, 'error')} and ${plural(nFixableWarn, 'warning')} potentially fixable with the \`--fix\` option.`);
+            console.error(styleText(['red', 'bold'], '  %s and %s potentially fixable with the `--fix` option.'), plural(nFixableErr, 'error'), plural(nFixableWarn, 'warning'));
         }
         console.error();
     }

package/dist/bin/config.js

@@ -41,7 +41,7 @@ const filterGadget = (id) => {
     const n = Number(id);
     return n < 2300 || n > 2303; // Gadget, Gadget talk, Gadget definition, Gadget definition talk
 };
-const pkg = 'wikilint', version = '2.47.0';
+const pkg = 'wikilint', version = '2.48.1';
 /**
  * Get the parser configuration for a Wikimedia Foundation project.
  * @param site site nickname
@@ -49,6 +49,7 @@ const pkg = 'wikilint', version = '2.47.0';
  * @param user URI for wiki userpage or email address of the user
  * @param force whether to overwrite the existing configuration
  * @param internal for internal use
+ * @throws `RangeError` if the site nickname or script path is missing, or Extension:CodeMirror is not installed
  */
 exports.default = async (site, url, user, force, internal) => {
     // wrong calls

package/dist/index.d.ts

@@ -5,7 +5,7 @@ import type { TitleOptions } from './lib/title';
 import type { LanguageService, QuickFixData } from './lib/lsp';
 import type { Token } from './internal';
 declare interface Parser extends ParserBase {
-    default: Parser;
+    default: this;
     /** @since v1.5.1 */
     readonly rules: readonly LintError.Rule[];
     configPaths: string[];
@@ -33,6 +33,7 @@ declare interface Parser extends ParserBase {
      *
      * 获取一个WMF网站的名称
      * @param url script path
+     * @throws `RangeError` if the URL is not a recognizable WMF site
      * @since v1.22.0
      */
     getWMFSite(url: string): [string, string];
@@ -43,6 +44,7 @@ declare interface Parser extends ParserBase {
      * @param site site nickname / 网站别名
      * @param url script path / 脚本路径
      * @param user URI for wiki userpage or email address of the user / 维基用户页面地址或用户的电子邮件地址
+     * @throws `RangeError` if Extension:CodeMirror is not installed
      * @since v1.18.4
      */
     fetchConfig(site: string, url: string, user?: string): Promise<Config>;

package/dist/index.js

@@ -20,7 +20,7 @@ const re = new RegExp(String.raw `^https?:\/\/([^./]+)\.(${common_1.wmf})\.org`,
 /**
  * require一个JSON文件
  * @param file 文件名
- * @throws {RangeError} 仅支持JSON文件
+ * @throws `RangeError` 仅支持JSON文件
  */
 const jsonRequire = (file) => {
     const fullPath = require.resolve(file);
@@ -159,7 +159,7 @@ const Parser = {
                 for (const key of keys) {
                     const str = t[key];
                     if (str?.includes('\0')) {
-                        const s = root.buildFromStr(str, constants_1.BuildMethod.Text);
+                        const s = root.buildFromStr(str, 1 /* BuildMethod.Text */);
                         if (key === 'main') {
                             t.main = s;
                         }

package/dist/lib/document.d.ts

@@ -1,8 +1,8 @@
 import type { Position } from 'vscode-languageserver-types';
 import type { TextDocument, Range } from 'vscode-languageserver-textdocument';
-import type { JSONDocument, LanguageService as JSONLanguageService } from 'vscode-json-languageservice';
-import type { Stylesheet, LanguageService as CSSLanguageService } from 'vscode-css-languageservice';
-import type { IHTMLDataProvider } from 'vscode-html-languageservice';
+import type * as JsonLanguageService from 'vscode-json-languageservice';
+import type * as CssLanguageService from 'vscode-css-languageservice';
+import type * as HtmlLanguageService from 'vscode-html-languageservice';
 import type { PublicApi } from 'stylelint';
 import type { Token } from '../internal';
 export interface TexvcLocation {
@@ -32,9 +32,9 @@ declare interface Texvcjs {
     }): TexvcReport;
 }
 export declare const loadTexvcjs: () => Texvcjs | null;
-export declare const loadJsonLSP: () => JSONLanguageService | null;
-export declare const loadCssLSP: () => CSSLanguageService | null;
-export declare const loadHtmlData: () => IHTMLDataProvider | null;
+export declare const loadJsonLSP: () => JsonLanguageService.LanguageService | null;
+export declare const loadCssLSP: () => CssLanguageService.LanguageService | null;
+export declare const loadHtmlData: () => HtmlLanguageService.IHTMLDataProvider | null;
 export declare const loadStylelint: () => PublicApi | null;
 /** embedded document */
 declare abstract class EmbeddedDocument implements TextDocument {
@@ -65,7 +65,7 @@ declare abstract class EmbeddedDocument implements TextDocument {
 }
 /** embedded JSON document */
 export declare class EmbeddedJSONDocument extends EmbeddedDocument {
-    jsonDoc: JSONDocument;
+    jsonDoc: JsonLanguageService.JSONDocument;
     abstract getLineRange(): Range;
     abstract getEOLCharacters(): string;
     /**
@@ -76,7 +76,7 @@ export declare class EmbeddedJSONDocument extends EmbeddedDocument {
 }
 /** embedded CSS document */
 export declare class EmbeddedCSSDocument extends EmbeddedDocument {
-    styleSheet: Stylesheet;
+    styleSheet: CssLanguageService.Stylesheet;
     abstract getLineRange(): Range;
     abstract getEOLCharacters(): string;
     /**

package/dist/lib/document.js

@@ -27,8 +27,7 @@ let jsonLSP;
 const loadJsonLSP = () => {
     if (jsonLSP === undefined) {
         try {
-            jsonLSP = require('vscode-json-languageservice')
-                .getLanguageService({
+            jsonLSP = require('vscode-json-languageservice').getLanguageService({
                 /* c8 ignore start */
                 /** @implements */
                 async schemaRequestService(uri) {
@@ -67,8 +66,7 @@ let cssLSP;
 const loadCssLSP = () => {
     if (cssLSP === undefined) {
         try {
-            cssLSP = require('vscode-css-languageservice')
-                .getCSSLanguageService();
+            cssLSP = require('vscode-css-languageservice').getCSSLanguageService();
         }
         catch /* c8 ignore start */ {
             cssLSP = null;

package/dist/lib/lsp.d.ts

@@ -1,6 +1,6 @@
 import Parser from '../index';
 import { Token } from '../src/index';
-import type { Range, Position, ColorInformation, ColorPresentation, FoldingRange, DocumentLink, Location, DocumentHighlight, WorkspaceEdit, Diagnostic as DiagnosticBase, TextEdit, Hover, SignatureHelp, InlayHint, CodeAction, DocumentSymbol } from 'vscode-languageserver-types';
+import type { Range, Position, ColorInformation, ColorPresentation, CompletionItem as CompletionItemBase, FoldingRange, DocumentLink, Location, DocumentHighlight, WorkspaceEdit, Diagnostic as DiagnosticBase, TextEdit, Hover, SignatureHelp, InlayHint, CodeAction, DocumentSymbol } from 'vscode-languageserver-types';
 import type { Config, LanguageService as LanguageServiceBase, CompletionItem, SignatureData } from '../base';
 import type { AttributeToken } from '../internal';
 import type { TokenTypeMap, SelectedTokenTypes } from '../map';
@@ -41,6 +41,14 @@ export declare class LanguageService implements LanguageServiceBase {
      * @param position position / 位置
      */
     provideCompletionItems(text: string, position: Position): Promise<CompletionItem[] | undefined>;
+    /**
+     * Add additional information to a completion item
+     *
+     * 为自动补全项添加额外信息
+     * @param item completion item / 自动补全项
+     * @since v1.48.0
+     */
+    resolveCompletionItem<T extends CompletionItem | CompletionItemBase>(item: T): T;
     /**
      * Provide grammar check
      *