11437826860

Committed 21 Oct 2024 10:04AM UTC coverage: 79.031% (+0.2%) from 78.841%

Build # 11437826860

Build Type

Pull #374

github

Committed by

web-flow

Commit Message

Merge 8173f84bd into 1acef8e47

Pull Request Pull Request #374: feat: Check Control renderer declaration

Run Details

1584 of 2135 branches covered (74.19%)

Branch coverage included in aggregate %.

30 of 33 new or added lines in 3 files covered. (90.91%)

21 existing lines in 2 files now uncovered.

2396 of 2901 relevant lines covered (82.59%)

1650.55 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.78

/src/linter/messages.ts

// TODO: Migrate to enum instead of Object/Map
// Currently, it's done this way to avoid pollution of the test snapshots
const RULES = {
        "async-component-flags": "async-component-flags",
        "csp-unsafe-inline-script": "csp-unsafe-inline-script",
        "no-deprecated-api": "no-deprecated-api",
        "no-deprecated-component": "no-deprecated-component",
        "no-deprecated-control-renderer-declaration": "no-deprecated-control-renderer-declaration",
        "no-deprecated-library": "no-deprecated-library",
        "no-deprecated-theme": "no-deprecated-theme",
        "no-globals": "no-globals",
        "no-pseudo-modules": "no-pseudo-modules",
        "parsing-error": "parsing-error",
} as const;

export enum LintMessageSeverity {
        Warning = 1,
        Error = 2,
}

// Messages (sorted alphabetically)
export enum MESSAGE {
        ABANDONED_BOOTSTRAP_PARAM,
        COMPONENT_MISSING_ASYNC_INTERFACE,
        COMPONENT_MISSING_MANIFEST_DECLARATION,
        COMPONENT_REDUNDANT_ASYNC_FLAG,
        CSP_UNSAFE_INLINE_SCRIPT,
        DEPRECATED_API_ACCESS,
        DEPRECATED_BOOTSTRAP_PARAM,
        DEPRECATED_CLASS,
        DEPRECATED_INTERFACE,
        DEPRECATED_TYPE,
        DEPRECATED_COMPONENT,
        DEPRECATED_CONTROL_RENDERER_DECLARATION,
        DEPRECATED_DECLARATIVE_SUPPORT,
        DEPRECATED_FUNCTION_CALL,
        DEPRECATED_LESS_SUPPORT,
        DEPRECATED_LIBRARY,
        DEPRECATED_MANIFEST_JS_RESOURCES,
        DEPRECATED_MODULE_IMPORT,
        DEPRECATED_ODATA_MODEL_V4_SYNCHRONIZATION_MODE,
        DEPRECATED_PROPERTY,
        DEPRECATED_PROPERTY_OF_CLASS,
        DEPRECATED_THEME,
        DEPRECATED_VIEW_TYPE,
        DUPLICATE_BOOTSTRAP_PARAM,
        HTML_IN_XML,
        LIB_INIT_API_VERSION,
        MISSING_BOOTSTRAP_PARAM,
        NO_DIRECT_DATATYPE_ACCESS,
        NO_DIRECT_ENUM_ACCESS,
        NO_GLOBALS,
        PARSING_ERROR,
        PARTIALLY_DEPRECATED_CORE_ROUTER,
        PARTIALLY_DEPRECATED_CREATE_COMPONENT,
        PARTIALLY_DEPRECATED_JSON_MODEL_LOAD_DATA,
        PARTIALLY_DEPRECATED_MOBILE_INIT,
        PARTIALLY_DEPRECATED_ODATA_MODEL_V2_CREATE_ENTRY,
        PARTIALLY_DEPRECATED_ODATA_MODEL_V2_CREATE_ENTRY_PROPERTIES_ARRAY,
        PARTIALLY_DEPRECATED_PARAMETERS_GET,
        REDUNDANT_BOOTSTRAP_PARAM,
        REDUNDANT_VIEW_CONFIG_PROPERTY,
        SPELLING_BOOTSTRAP_PARAM,
        SVG_IN_XML,
}
export const MESSAGE_INFO = {

        [MESSAGE.ABANDONED_BOOTSTRAP_PARAM]: {
                severity: LintMessageSeverity.Warning,
                ruleId: RULES["no-deprecated-api"],

                message: ({name}: {name: string}) =>
                        `Abandoned bootstrap parameter '${name}' should be removed`,
                details: () => undefined,
        },

        [MESSAGE.COMPONENT_MISSING_ASYNC_INTERFACE]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["async-component-flags"],

                message: () =>
                        `Component is not configured for asynchronous loading.`,
                details: ({componentFileName, asyncFlagMissingIn}: {componentFileName: string; asyncFlagMissingIn: string}) =>
                        `{@link topic:676b636446c94eada183b1218a824717 Use Asynchronous Loading}. ` +
                        `Implement sap.ui.core.IAsyncContentCreation interface in ${componentFileName}. ` +
                        `Alternatively, set the 'async' flag to 'true' in ${asyncFlagMissingIn} in the component manifest.`,
        },

        [MESSAGE.COMPONENT_MISSING_MANIFEST_DECLARATION]: {
                severity: LintMessageSeverity.Warning,
                ruleId: RULES["async-component-flags"],

                message: () =>
                        `Component does not specify that it uses the descriptor via the manifest.json file`,
                details: () =>
                        `A manifest.json has been found in the same directory as the component. Although it will be used at ` +
                        `runtime automatically, this should still be expressed in the ` +
                        `{@link topic:0187ea5e2eff4166b0453b9dcc8fc64f metadata of the component class}.`,
        },

        [MESSAGE.COMPONENT_REDUNDANT_ASYNC_FLAG]: {
                severity: LintMessageSeverity.Warning,
                ruleId: RULES["async-component-flags"],

                message: ({asyncFlagLocation}: {asyncFlagLocation: string}) =>
                        `Component implements the sap.ui.core.IAsyncContentCreation interface. ` +
                        `The redundant 'async' flag at '${asyncFlagLocation}' should be removed from the component manifest`,
                details: () =>
                        `{@link sap.ui.core.IAsyncContentCreation sap.ui.core.IAsyncContentCreation}`,
        },

        [MESSAGE.CSP_UNSAFE_INLINE_SCRIPT]: {
                severity: LintMessageSeverity.Warning,
                ruleId: RULES["csp-unsafe-inline-script"],

                message: () => `Use of unsafe inline script`,
                details: () => `{@link topic:fe1a6dba940e479fb7c3bc753f92b28c Content Security Policy}`,
        },

        [MESSAGE.DEPRECATED_API_ACCESS]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({apiName}: {apiName: string}) =>
                        `Use of deprecated API '${apiName}'`,
                details: ({details}: {details: string}) => details,
        },

        [MESSAGE.DEPRECATED_BOOTSTRAP_PARAM]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({name, value}: {name: string; value: string}) =>
                        `Use of deprecated value '${value}' for bootstrap parameter '${name}'`,
                details: ({details}: {details?: string}) => details,
        },

        [MESSAGE.DEPRECATED_CLASS]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({className}: {className: string}) =>
                        `Use of deprecated class '${className}'`,
                details: ({details}: {details: string}) => details,
        },

        [MESSAGE.DEPRECATED_INTERFACE]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({interfaceName}: {interfaceName: string}) =>
                        `Use of deprecated interface '${interfaceName}'`,
                details: ({details}: {details: string}) => details,
        },

        [MESSAGE.DEPRECATED_TYPE]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({typeName}: {typeName: string}) =>
                        `Use of deprecated type '${typeName}'`,
                details: ({details}: {details: string}) => details,
        },

        [MESSAGE.DEPRECATED_COMPONENT]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-component"],

                message: ({componentName}: {componentName: string}) =>
                        `Use of deprecated component '${componentName}'`,
                details: () => undefined,
        },

        [MESSAGE.DEPRECATED_CONTROL_RENDERER_DECLARATION]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-control-renderer-declaration"],

                message: () =>
                        `TBD`,
                details: () => undefined,
        },

        [MESSAGE.DEPRECATED_DECLARATIVE_SUPPORT]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () => `DeclarativeSupport is deprecated`,
                details: () =>
                        `Please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or` +
                        ` {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed Views} instead. For more information,` +
                        ` see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.`,
        },

        [MESSAGE.DEPRECATED_FUNCTION_CALL]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({functionName, additionalMessage}: {functionName: string; additionalMessage: string}) =>
                        `Call to deprecated function '${functionName}'${additionalMessage ? ` ${additionalMessage}` : ""}`,
                details: ({details}: {details: string}) => details,
        },

        [MESSAGE.DEPRECATED_LESS_SUPPORT]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () => `LessSupport is deprecated`,
                details: () =>
                        "Please consider using UI5 Tooling https://sap.github.io/ui5-tooling/stable/ to compile LESS to CSS on the fly.",
        },

        [MESSAGE.DEPRECATED_LIBRARY]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-library"],

                message: ({libraryName}: {libraryName: string}) =>
                        `Use of deprecated library '${libraryName}'`,
                details: () => undefined,
        },

        [MESSAGE.DEPRECATED_MANIFEST_JS_RESOURCES]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () =>
                        `Use of deprecated property 'sap.ui5/resources/js'`,
                details: () => "As of version 1.94, the usage of js resources is deprecated. " +
                        "Please use regular dependencies instead.",
        },

        [MESSAGE.DEPRECATED_MODULE_IMPORT]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({moduleName}: {moduleName: string}) =>
                        `Import of deprecated module '${moduleName}'`,
                details: ({details}: {details: string}) => details,
        },

        [MESSAGE.DEPRECATED_ODATA_MODEL_V4_SYNCHRONIZATION_MODE]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({modelName}: {modelName?: string}) =>
                        `Usage of deprecated parameter 'synchronizationMode' ` +
                        `of constructor 'sap/ui/model/odata/v4/ODataModel'${modelName ? ` (model: '${modelName}')` : ""}`,
                details: () =>
                        `As of version 1.110.0, the 'synchronizationMode' parameter is obsolete and must be omitted. ` +
                        `{@link sap/ui/model/odata/v4/ODataModel#constructor See the API reference}`,
        },

        [MESSAGE.DEPRECATED_PROPERTY]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({propertyName}: {propertyName: string}) =>
                        `Use of deprecated property '${propertyName}'`,
                details: ({details}: {details: string}) => details,
        },

        [MESSAGE.DEPRECATED_PROPERTY_OF_CLASS]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({propertyName, className}: {propertyName: string; className: string}) =>
                        `Use of deprecated property '${propertyName}' of class '${className}'`,
                details: ({details}: {details: string}) => details,
        },

        [MESSAGE.DEPRECATED_THEME]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-theme"],

                message: ({themeName}: {themeName: string}) =>
                        `Use of deprecated theme '${themeName}'`,
                details: () => `{@link topic:a87ca843bcee469f82a9072927a7dcdb Deprecated Themes and Libraries}`,
        },

        [MESSAGE.DEPRECATED_VIEW_TYPE]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({viewType}: {viewType: string}) =>
                        `Use of deprecated view type '${viewType}'. Use 'XML' instead'`,
                details: () => undefined,
        },

        [MESSAGE.DUPLICATE_BOOTSTRAP_PARAM]: {
                severity: LintMessageSeverity.Warning,
                ruleId: RULES["no-deprecated-api"],

                message: ({name, value}: {name: string; value: string}) =>
                        `Duplicate bootstrap parameter '${name}' with value '${value}'`,
                details: () => undefined,
        },

        [MESSAGE.MISSING_BOOTSTRAP_PARAM]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({name}: {name: string}) =>
                        `Missing bootstrap parameter '${name}'`,
                details: ({details}: {details?: string}) => details,
        },

        [MESSAGE.HTML_IN_XML]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () => `Usage of native HTML in XML Views/Fragments is deprecated`,
                details: () => `{@link topic:be54950cae1041f59d4aa97a6bade2d8 Using Native HTML in XML Views (deprecated)}`,
        },

        [MESSAGE.LIB_INIT_API_VERSION]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({libInitFunction}: {libInitFunction: string}) =>
                        `Deprecated call to ${libInitFunction}(). Use the {apiVersion: 2} parameter instead`,
                details: () => `{@link sap.ui.core.Lib.init Lib.init}`,
        },

        [MESSAGE.NO_DIRECT_DATATYPE_ACCESS]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-pseudo-modules"],

                message: ({moduleName}: {moduleName: string}) =>
                        `Deprecated access of DataType pseudo module '${moduleName}'`,
                details: () =>
                        "{@link topic:00737d6c1b864dc3ab72ef56611491c4 Migrating Access to Pseudo Modules}",
        },

        [MESSAGE.NO_DIRECT_ENUM_ACCESS]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-pseudo-modules"],

                message: ({moduleName}: {moduleName: string}) =>
                        `Deprecated access of enum pseudo module '${moduleName}'`,
                details: () =>
                        "{@link topic:00737d6c1b864dc3ab72ef56611491c4 Migrating Access to Pseudo Modules}",
        },

        [MESSAGE.NO_GLOBALS]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-globals"],

                message: ({variableName, namespace}: {variableName: string; namespace: string}) =>
                        `Access of global variable '${variableName}' (${namespace})`,
                details: () =>
                        `Do not use global variables to access UI5 modules or APIs. ` +
                        `{@link topic:28fcd55b04654977b63dacbee0552712 See Best Practices for Developers}`,
        },

        [MESSAGE.PARSING_ERROR]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["parsing-error"],
                fatal: true,

                message: ({message}: {message: string}) => message,
                details: () => `Check the source file for syntax errors`,
        },

        [MESSAGE.PARTIALLY_DEPRECATED_CORE_ROUTER]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () =>
                        `Usage of deprecated value for parameter 'oConfig.async' of constructor 'sap/ui/core/Router'`,
                details: () =>
                        `The 'oConfig.async' parameter must be set to true. ` +
                        `{@link sap/ui/core/routing/Router#constructor See the API reference}`,
        },

        [MESSAGE.PARTIALLY_DEPRECATED_CREATE_COMPONENT]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () =>
                        `Usage of deprecated value for parameter 'async' of 'sap/ui/core/Component#createComponent'`,
                details: () => `The 'async' property must be either omitted or set to true. ` +
                        `{@link sap.ui.core.Component#createComponent See the API reference}`,
        },

        [MESSAGE.PARTIALLY_DEPRECATED_JSON_MODEL_LOAD_DATA]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({paramName}: {paramName: string}) =>
                        `Usage of deprecated value for parameter '${paramName}' of 'sap/ui/model/json/JSONModel#loadData'`,
                details: ({paramName}: {paramName: string}) =>
                        `Parameter '${paramName}' must be either omitted or set to true. ` +
                        `{@link sap.ui.model.json.JSONModel#loadData See API reference}`,
        },

        [MESSAGE.PARTIALLY_DEPRECATED_MOBILE_INIT]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: ({paramName}: {paramName: string}) =>
                        `Usage of deprecated value for parameter '${paramName}' of 'sap/ui/util/Mobile#init'`,
                details: ({paramName}: {paramName: string}) =>
                        `Parameter '${paramName}' must be either omitted or set to true. ` +
                        `{@link sap.ui.util.Mobile#init See API reference}`,
        },

        [MESSAGE.PARTIALLY_DEPRECATED_ODATA_MODEL_V2_CREATE_ENTRY]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () =>
                        `Usage of deprecated parameter 'batchGroupId' in 'sap/ui/model/odata/v2/ODataModel#createEntry'`,
                details: () => `Use the 'groupId' parameter instead. ` +
                        `{@link sap.ui.model.odata.v2.ODataModel#createEntry See the API reference}`,
        },

        [MESSAGE.PARTIALLY_DEPRECATED_ODATA_MODEL_V2_CREATE_ENTRY_PROPERTIES_ARRAY]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () =>
                        `Usage of deprecated value for parameter 'properties' in 'sap/ui/model/odata/v2/ODataModel#createEntry'`,
                details: () =>
                        `Passing a list of property names is deprecated. Pass the initial values as an object instead. ` +
                        `{@link sap.ui.model.odata.v2.ODataModel#createEntry See the API reference}`,
        },

        [MESSAGE.PARTIALLY_DEPRECATED_PARAMETERS_GET]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () =>
                        `Usage of deprecated variant of 'sap/ui/core/theming/Parameters.get'`,
                details: () => `{@link sap.ui.core.theming.Parameters#sap.ui.core.theming.Parameters.get Parameters.get}`,
        },

        [MESSAGE.REDUNDANT_BOOTSTRAP_PARAM]: {
                severity: LintMessageSeverity.Warning,
                ruleId: RULES["no-deprecated-api"],

                message: ({name}: {name: string}) =>
                        `Redundant bootstrap parameter '${name}' should be removed`,
                details: () => undefined,
        },

        [MESSAGE.REDUNDANT_VIEW_CONFIG_PROPERTY]: {
                severity: LintMessageSeverity.Warning,
                ruleId: RULES["no-deprecated-api"],

                message: ({propertyName}: {propertyName: string}) =>
                        `Redundant view configuration property '${propertyName}' can be omitted`,
                details: () => undefined,
        },

        [MESSAGE.SPELLING_BOOTSTRAP_PARAM]: {
                severity: LintMessageSeverity.Warning,
                ruleId: RULES["no-deprecated-api"],

                message: ({oldName, newName}: {oldName: string; newName: string}) =>
                        `Outdated spelling of bootstrap parameter: '${oldName}'; should be written as '${newName}'`,
                details: () => undefined,
        },

        [MESSAGE.SVG_IN_XML]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () => `Deprecated use of SVG in XML View or Fragment`,
                details: () => `{@link topic:28fcd55b04654977b63dacbee0552712 See Best Practices for Developers}`,
        },

} as const;

1	// TODO: Migrate to enum instead of Object/Map
2	// Currently, it's done this way to avoid pollution of the test snapshots
3	const RULES = {	12✔
4	"async-component-flags": "async-component-flags",
5	"csp-unsafe-inline-script": "csp-unsafe-inline-script",
6	"no-deprecated-api": "no-deprecated-api",
7	"no-deprecated-component": "no-deprecated-component",
8	"no-deprecated-control-renderer-declaration": "no-deprecated-control-renderer-declaration",
9	"no-deprecated-library": "no-deprecated-library",
10	"no-deprecated-theme": "no-deprecated-theme",
11	"no-globals": "no-globals",
12	"no-pseudo-modules": "no-pseudo-modules",
13	"parsing-error": "parsing-error",
14	} as const;
15
16	export enum LintMessageSeverity {
17	Warning = 1,
18	Error = 2,
19	}
20
21	// Messages (sorted alphabetically)
22	export enum MESSAGE {
23	ABANDONED_BOOTSTRAP_PARAM,
24	COMPONENT_MISSING_ASYNC_INTERFACE,
25	COMPONENT_MISSING_MANIFEST_DECLARATION,
26	COMPONENT_REDUNDANT_ASYNC_FLAG,
27	CSP_UNSAFE_INLINE_SCRIPT,
28	DEPRECATED_API_ACCESS,
29	DEPRECATED_BOOTSTRAP_PARAM,
30	DEPRECATED_CLASS,
31	DEPRECATED_INTERFACE,
32	DEPRECATED_TYPE,
33	DEPRECATED_COMPONENT,
34	DEPRECATED_CONTROL_RENDERER_DECLARATION,
35	DEPRECATED_DECLARATIVE_SUPPORT,
36	DEPRECATED_FUNCTION_CALL,
37	DEPRECATED_LESS_SUPPORT,
38	DEPRECATED_LIBRARY,
39	DEPRECATED_MANIFEST_JS_RESOURCES,
40	DEPRECATED_MODULE_IMPORT,
41	DEPRECATED_ODATA_MODEL_V4_SYNCHRONIZATION_MODE,
42	DEPRECATED_PROPERTY,
43	DEPRECATED_PROPERTY_OF_CLASS,
44	DEPRECATED_THEME,
45	DEPRECATED_VIEW_TYPE,
46	DUPLICATE_BOOTSTRAP_PARAM,
47	HTML_IN_XML,
48	LIB_INIT_API_VERSION,
49	MISSING_BOOTSTRAP_PARAM,
50	NO_DIRECT_DATATYPE_ACCESS,
51	NO_DIRECT_ENUM_ACCESS,
52	NO_GLOBALS,
53	PARSING_ERROR,
54	PARTIALLY_DEPRECATED_CORE_ROUTER,
55	PARTIALLY_DEPRECATED_CREATE_COMPONENT,
56	PARTIALLY_DEPRECATED_JSON_MODEL_LOAD_DATA,
57	PARTIALLY_DEPRECATED_MOBILE_INIT,
58	PARTIALLY_DEPRECATED_ODATA_MODEL_V2_CREATE_ENTRY,
59	PARTIALLY_DEPRECATED_ODATA_MODEL_V2_CREATE_ENTRY_PROPERTIES_ARRAY,
60	PARTIALLY_DEPRECATED_PARAMETERS_GET,
61	REDUNDANT_BOOTSTRAP_PARAM,
62	REDUNDANT_VIEW_CONFIG_PROPERTY,
63	SPELLING_BOOTSTRAP_PARAM,
64	SVG_IN_XML,
65	}
66	export const MESSAGE_INFO = {	12✔
67
68	[MESSAGE.ABANDONED_BOOTSTRAP_PARAM]: {
69	severity: LintMessageSeverity.Warning,
70	ruleId: RULES["no-deprecated-api"],
71
72	message: ({name}: {name: string}) =>
73	`Abandoned bootstrap parameter '${name}' should be removed`,	1✔
74	details: () => undefined,	1✔
75	},
76
77	[MESSAGE.COMPONENT_MISSING_ASYNC_INTERFACE]: {
78	severity: LintMessageSeverity.Error,
79	ruleId: RULES["async-component-flags"],
80
81	message: () =>
82	`Component is not configured for asynchronous loading.`,	7✔
83	details: ({componentFileName, asyncFlagMissingIn}: {componentFileName: string; asyncFlagMissingIn: string}) =>
84	`{@link topic:676b636446c94eada183b1218a824717 Use Asynchronous Loading}. ` +	7✔
85	`Implement sap.ui.core.IAsyncContentCreation interface in ${componentFileName}. ` +
86	`Alternatively, set the 'async' flag to 'true' in ${asyncFlagMissingIn} in the component manifest.`,
87	},
88
89	[MESSAGE.COMPONENT_MISSING_MANIFEST_DECLARATION]: {
90	severity: LintMessageSeverity.Warning,
91	ruleId: RULES["async-component-flags"],
92
93	message: () =>
94	`Component does not specify that it uses the descriptor via the manifest.json file`,	2✔
95	details: () =>
96	`A manifest.json has been found in the same directory as the component. Although it will be used at ` +	2✔
97	`runtime automatically, this should still be expressed in the ` +
98	`{@link topic:0187ea5e2eff4166b0453b9dcc8fc64f metadata of the component class}.`,
99	},
100
101	[MESSAGE.COMPONENT_REDUNDANT_ASYNC_FLAG]: {
102	severity: LintMessageSeverity.Warning,
103	ruleId: RULES["async-component-flags"],
104
105	message: ({asyncFlagLocation}: {asyncFlagLocation: string}) =>
106	`Component implements the sap.ui.core.IAsyncContentCreation interface. ` +	6✔
107	`The redundant 'async' flag at '${asyncFlagLocation}' should be removed from the component manifest`,
108	details: () =>
109	`{@link sap.ui.core.IAsyncContentCreation sap.ui.core.IAsyncContentCreation}`,	6✔
110	},
111
112	[MESSAGE.CSP_UNSAFE_INLINE_SCRIPT]: {
113	severity: LintMessageSeverity.Warning,
114	ruleId: RULES["csp-unsafe-inline-script"],
115
116	message: () => `Use of unsafe inline script`,	10✔
117	details: () => `{@link topic:fe1a6dba940e479fb7c3bc753f92b28c Content Security Policy}`,	7✔
118	},
119
120	[MESSAGE.DEPRECATED_API_ACCESS]: {
121	severity: LintMessageSeverity.Error,
122	ruleId: RULES["no-deprecated-api"],
123
124	message: ({apiName}: {apiName: string}) =>
125	`Use of deprecated API '${apiName}'`,	15✔
126	details: ({details}: {details: string}) => details,	15✔
127	},
128
129	[MESSAGE.DEPRECATED_BOOTSTRAP_PARAM]: {
130	severity: LintMessageSeverity.Error,
131	ruleId: RULES["no-deprecated-api"],
132
133	message: ({name, value}: {name: string; value: string}) =>
134	`Use of deprecated value '${value}' for bootstrap parameter '${name}'`,	6✔
135	details: ({details}: {details?: string}) => details,	6✔
136	},
137
138	[MESSAGE.DEPRECATED_CLASS]: {
139	severity: LintMessageSeverity.Error,
140	ruleId: RULES["no-deprecated-api"],
141
142	message: ({className}: {className: string}) =>
143	`Use of deprecated class '${className}'`,	22✔
144	details: ({details}: {details: string}) => details,	19✔
145	},
146
147	[MESSAGE.DEPRECATED_INTERFACE]: {
148	severity: LintMessageSeverity.Error,
149	ruleId: RULES["no-deprecated-api"],
150
151	message: ({interfaceName}: {interfaceName: string}) =>
152	`Use of deprecated interface '${interfaceName}'`,	3✔
153	details: ({details}: {details: string}) => details,	3✔
154	},
155
156	[MESSAGE.DEPRECATED_TYPE]: {
157	severity: LintMessageSeverity.Error,
158	ruleId: RULES["no-deprecated-api"],
159
160	message: ({typeName}: {typeName: string}) =>
161	`Use of deprecated type '${typeName}'`,	27✔
162	details: ({details}: {details: string}) => details,	27✔
163	},
164
165	[MESSAGE.DEPRECATED_COMPONENT]: {
166	severity: LintMessageSeverity.Error,
167	ruleId: RULES["no-deprecated-component"],
168
169	message: ({componentName}: {componentName: string}) =>
170	`Use of deprecated component '${componentName}'`,	1✔
171	details: () => undefined,	1✔
172	},
173
174	[MESSAGE.DEPRECATED_CONTROL_RENDERER_DECLARATION]: {
175	severity: LintMessageSeverity.Error,
176	ruleId: RULES["no-deprecated-control-renderer-declaration"],
177
178	message: () =>
179	`TBD`,	5✔
180	details: () => undefined,	5✔
181	},
182
183	[MESSAGE.DEPRECATED_DECLARATIVE_SUPPORT]: {
184	severity: LintMessageSeverity.Error,
185	ruleId: RULES["no-deprecated-api"],
186
187	message: () => `DeclarativeSupport is deprecated`,	2✔
188	details: () =>
189	`Please consider using {@link sap.ui.core.mvc.XMLView XMLViews} or` +	2✔
190	` {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed Views} instead. For more information,` +
191	` see the documentation on {@link topic:91f27e3e6f4d1014b6dd926db0e91070 View types}.`,
192	},
193
194	[MESSAGE.DEPRECATED_FUNCTION_CALL]: {
195	severity: LintMessageSeverity.Error,
196	ruleId: RULES["no-deprecated-api"],
197
198	message: ({functionName, additionalMessage}: {functionName: string; additionalMessage: string}) =>
199	`Call to deprecated function '${functionName}'${additionalMessage ? ` ${additionalMessage}` : ""}`,	65✔
200	details: ({details}: {details: string}) => details,	42✔
201	},
202
203	[MESSAGE.DEPRECATED_LESS_SUPPORT]: {
204	severity: LintMessageSeverity.Error,
205	ruleId: RULES["no-deprecated-api"],
206
207	message: () => `LessSupport is deprecated`,	1✔
208	details: () =>
209	"Please consider using UI5 Tooling https://sap.github.io/ui5-tooling/stable/ to compile LESS to CSS on the fly.",	1✔
210	},
211
212	[MESSAGE.DEPRECATED_LIBRARY]: {
213	severity: LintMessageSeverity.Error,
214	ruleId: RULES["no-deprecated-library"],
215
216	message: ({libraryName}: {libraryName: string}) =>
217	`Use of deprecated library '${libraryName}'`,	110✔
218	details: () => undefined,	79✔
219	},
220
221	[MESSAGE.DEPRECATED_MANIFEST_JS_RESOURCES]: {
222	severity: LintMessageSeverity.Error,
223	ruleId: RULES["no-deprecated-api"],
224
225	message: () =>
226	`Use of deprecated property 'sap.ui5/resources/js'`,	7✔
227	details: () => "As of version 1.94, the usage of js resources is deprecated. " +	4✔
228	"Please use regular dependencies instead.",
229	},
230
231	[MESSAGE.DEPRECATED_MODULE_IMPORT]: {
232	severity: LintMessageSeverity.Error,
233	ruleId: RULES["no-deprecated-api"],
234
235	message: ({moduleName}: {moduleName: string}) =>
236	`Import of deprecated module '${moduleName}'`,	25✔
237	details: ({details}: {details: string}) => details,	22✔
238	},
239
240	[MESSAGE.DEPRECATED_ODATA_MODEL_V4_SYNCHRONIZATION_MODE]: {
241	severity: LintMessageSeverity.Error,
242	ruleId: RULES["no-deprecated-api"],
243
244	message: ({modelName}: {modelName?: string}) =>
245	`Usage of deprecated parameter 'synchronizationMode' ` +	16✔
246	`of constructor 'sap/ui/model/odata/v4/ODataModel'${modelName ? ` (model: '${modelName}')` : ""}`,	16✔
247	details: () =>
248	`As of version 1.110.0, the 'synchronizationMode' parameter is obsolete and must be omitted. ` +	10✔
249	`{@link sap/ui/model/odata/v4/ODataModel#constructor See the API reference}`,
250	},
251
252	[MESSAGE.DEPRECATED_PROPERTY]: {
253	severity: LintMessageSeverity.Error,
254	ruleId: RULES["no-deprecated-api"],
255
256	message: ({propertyName}: {propertyName: string}) =>
257	`Use of deprecated property '${propertyName}'`,	21✔
258	details: ({details}: {details: string}) => details,	21✔
259	},
260
261	[MESSAGE.DEPRECATED_PROPERTY_OF_CLASS]: {
262	severity: LintMessageSeverity.Error,
263	ruleId: RULES["no-deprecated-api"],
264
265	message: ({propertyName, className}: {propertyName: string; className: string}) =>
266	`Use of deprecated property '${propertyName}' of class '${className}'`,	42✔
267	details: ({details}: {details: string}) => details,	34✔
268	},
269
270	[MESSAGE.DEPRECATED_THEME]: {
271	severity: LintMessageSeverity.Error,
272	ruleId: RULES["no-deprecated-theme"],
273
274	message: ({themeName}: {themeName: string}) =>
275	`Use of deprecated theme '${themeName}'`,	3✔
276	details: () => `{@link topic:a87ca843bcee469f82a9072927a7dcdb Deprecated Themes and Libraries}`,	3✔
277	},
278
279	[MESSAGE.DEPRECATED_VIEW_TYPE]: {
280	severity: LintMessageSeverity.Error,
281	ruleId: RULES["no-deprecated-api"],
282
283	message: ({viewType}: {viewType: string}) =>
284	`Use of deprecated view type '${viewType}'. Use 'XML' instead'`,	8✔
285	details: () => undefined,	8✔
286	},
287
288	[MESSAGE.DUPLICATE_BOOTSTRAP_PARAM]: {
289	severity: LintMessageSeverity.Warning,
290	ruleId: RULES["no-deprecated-api"],
291
292	message: ({name, value}: {name: string; value: string}) =>
293	`Duplicate bootstrap parameter '${name}' with value '${value}'`,	4✔
294	details: () => undefined,	4✔
295	},
296
297	[MESSAGE.MISSING_BOOTSTRAP_PARAM]: {
298	severity: LintMessageSeverity.Error,
299	ruleId: RULES["no-deprecated-api"],
300
301	message: ({name}: {name: string}) =>
302	`Missing bootstrap parameter '${name}'`,	11✔
303	details: ({details}: {details?: string}) => details,	8✔
304	},
305
306	[MESSAGE.HTML_IN_XML]: {
307	severity: LintMessageSeverity.Error,
308	ruleId: RULES["no-deprecated-api"],
309
310	message: () => `Usage of native HTML in XML Views/Fragments is deprecated`,	2✔
311	details: () => `{@link topic:be54950cae1041f59d4aa97a6bade2d8 Using Native HTML in XML Views (deprecated)}`,	2✔
312	},
313
314	[MESSAGE.LIB_INIT_API_VERSION]: {
315	severity: LintMessageSeverity.Error,
316	ruleId: RULES["no-deprecated-api"],
317
318	message: ({libInitFunction}: {libInitFunction: string}) =>
319	`Deprecated call to ${libInitFunction}(). Use the {apiVersion: 2} parameter instead`,	11✔
320	details: () => `{@link sap.ui.core.Lib.init Lib.init}`,	11✔
321	},
322
323	[MESSAGE.NO_DIRECT_DATATYPE_ACCESS]: {
324	severity: LintMessageSeverity.Error,
325	ruleId: RULES["no-pseudo-modules"],
326
327	message: ({moduleName}: {moduleName: string}) =>
328	`Deprecated access of DataType pseudo module '${moduleName}'`,	1✔
329	details: () =>
330	"{@link topic:00737d6c1b864dc3ab72ef56611491c4 Migrating Access to Pseudo Modules}",	1✔
331	},
332
333	[MESSAGE.NO_DIRECT_ENUM_ACCESS]: {
334	severity: LintMessageSeverity.Error,
335	ruleId: RULES["no-pseudo-modules"],
336
337	message: ({moduleName}: {moduleName: string}) =>
338	`Deprecated access of enum pseudo module '${moduleName}'`,	10✔
339	details: () =>
340	"{@link topic:00737d6c1b864dc3ab72ef56611491c4 Migrating Access to Pseudo Modules}",	4✔
341	},
342
343	[MESSAGE.NO_GLOBALS]: {
344	severity: LintMessageSeverity.Error,
345	ruleId: RULES["no-globals"],
346
347	message: ({variableName, namespace}: {variableName: string; namespace: string}) =>
348	`Access of global variable '${variableName}' (${namespace})`,	23✔
349	details: () =>
350	`Do not use global variables to access UI5 modules or APIs. ` +	17✔
351	`{@link topic:28fcd55b04654977b63dacbee0552712 See Best Practices for Developers}`,
352	},
353
354	[MESSAGE.PARSING_ERROR]: {
355	severity: LintMessageSeverity.Error,
356	ruleId: RULES["parsing-error"],
357	fatal: true,
358
UNCOV 359	message: ({message}: {message: string}) => message,	×
UNCOV 360	details: () => `Check the source file for syntax errors`,	×
361	},
362
363	[MESSAGE.PARTIALLY_DEPRECATED_CORE_ROUTER]: {
364	severity: LintMessageSeverity.Error,
365	ruleId: RULES["no-deprecated-api"],
366
367	message: () =>
368	`Usage of deprecated value for parameter 'oConfig.async' of constructor 'sap/ui/core/Router'`,	2✔
369	details: () =>
370	`The 'oConfig.async' parameter must be set to true. ` +	2✔
371	`{@link sap/ui/core/routing/Router#constructor See the API reference}`,
372	},
373
374	[MESSAGE.PARTIALLY_DEPRECATED_CREATE_COMPONENT]: {
375	severity: LintMessageSeverity.Error,
376	ruleId: RULES["no-deprecated-api"],
377
378	message: () =>
379	`Usage of deprecated value for parameter 'async' of 'sap/ui/core/Component#createComponent'`,	1✔
380	details: () => `The 'async' property must be either omitted or set to true. ` +	1✔
381	`{@link sap.ui.core.Component#createComponent See the API reference}`,
382	},
383
384	[MESSAGE.PARTIALLY_DEPRECATED_JSON_MODEL_LOAD_DATA]: {
385	severity: LintMessageSeverity.Error,
386	ruleId: RULES["no-deprecated-api"],
387
388	message: ({paramName}: {paramName: string}) =>
389	`Usage of deprecated value for parameter '${paramName}' of 'sap/ui/model/json/JSONModel#loadData'`,	2✔
390	details: ({paramName}: {paramName: string}) =>
391	`Parameter '${paramName}' must be either omitted or set to true. ` +	2✔
392	`{@link sap.ui.model.json.JSONModel#loadData See API reference}`,
393	},
394
395	[MESSAGE.PARTIALLY_DEPRECATED_MOBILE_INIT]: {
396	severity: LintMessageSeverity.Error,
397	ruleId: RULES["no-deprecated-api"],
398
399	message: ({paramName}: {paramName: string}) =>
400	`Usage of deprecated value for parameter '${paramName}' of 'sap/ui/util/Mobile#init'`,	2✔
401	details: ({paramName}: {paramName: string}) =>
402	`Parameter '${paramName}' must be either omitted or set to true. ` +	2✔
403	`{@link sap.ui.util.Mobile#init See API reference}`,
404	},
405
406	[MESSAGE.PARTIALLY_DEPRECATED_ODATA_MODEL_V2_CREATE_ENTRY]: {
407	severity: LintMessageSeverity.Error,
408	ruleId: RULES["no-deprecated-api"],
409
410	message: () =>
411	`Usage of deprecated parameter 'batchGroupId' in 'sap/ui/model/odata/v2/ODataModel#createEntry'`,	1✔
412	details: () => `Use the 'groupId' parameter instead. ` +	1✔
413	`{@link sap.ui.model.odata.v2.ODataModel#createEntry See the API reference}`,
414	},
415
416	[MESSAGE.PARTIALLY_DEPRECATED_ODATA_MODEL_V2_CREATE_ENTRY_PROPERTIES_ARRAY]: {
417	severity: LintMessageSeverity.Error,
418	ruleId: RULES["no-deprecated-api"],
419
420	message: () =>
421	`Usage of deprecated value for parameter 'properties' in 'sap/ui/model/odata/v2/ODataModel#createEntry'`,	1✔
422	details: () =>
423	`Passing a list of property names is deprecated. Pass the initial values as an object instead. ` +	1✔
424	`{@link sap.ui.model.odata.v2.ODataModel#createEntry See the API reference}`,
425	},
426
427	[MESSAGE.PARTIALLY_DEPRECATED_PARAMETERS_GET]: {
428	severity: LintMessageSeverity.Error,
429	ruleId: RULES["no-deprecated-api"],
430
431	message: () =>
432	`Usage of deprecated variant of 'sap/ui/core/theming/Parameters.get'`,	4✔
433	details: () => `{@link sap.ui.core.theming.Parameters#sap.ui.core.theming.Parameters.get Parameters.get}`,	4✔
434	},
435
436	[MESSAGE.REDUNDANT_BOOTSTRAP_PARAM]: {
437	severity: LintMessageSeverity.Warning,
438	ruleId: RULES["no-deprecated-api"],
439
440	message: ({name}: {name: string}) =>
441	`Redundant bootstrap parameter '${name}' should be removed`,	5✔
442	details: () => undefined,	5✔
443	},
444
445	[MESSAGE.REDUNDANT_VIEW_CONFIG_PROPERTY]: {
446	severity: LintMessageSeverity.Warning,
447	ruleId: RULES["no-deprecated-api"],
448
449	message: ({propertyName}: {propertyName: string}) =>
450	`Redundant view configuration property '${propertyName}' can be omitted`,	1✔
451	details: () => undefined,	1✔
452	},
453
454	[MESSAGE.SPELLING_BOOTSTRAP_PARAM]: {
455	severity: LintMessageSeverity.Warning,
456	ruleId: RULES["no-deprecated-api"],
457
458	message: ({oldName, newName}: {oldName: string; newName: string}) =>
459	`Outdated spelling of bootstrap parameter: '${oldName}'; should be written as '${newName}'`,	68✔
460	details: () => undefined,	29✔
461	},
462
463	[MESSAGE.SVG_IN_XML]: {
464	severity: LintMessageSeverity.Error,
465	ruleId: RULES["no-deprecated-api"],
466
467	message: () => `Deprecated use of SVG in XML View or Fragment`,	6✔
468	details: () => `{@link topic:28fcd55b04654977b63dacbee0552712 See Best Practices for Developers}`,	6✔
469	},
470
471	} as const;

SAP / ui5-linter / 11437826860

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous