11514284751

Committed 25 Oct 2024 08:02AM UTC coverage: 79.669% (+0.4%) from 79.31%

Build # 11514284751

Build Type

Pull #366

github

Committed by

web-flow

Commit Message

Merge a7e173a40 into 2d4bcfabd

Pull Request Pull Request #366: feat: Detect renderer's deprecations

Run Details

1699 of 2261 branches covered (75.14%)

Branch coverage included in aggregate %.

91 of 97 new or added lines in 4 files covered. (93.81%)

18 existing lines in 2 files now uncovered.

2490 of 2997 relevant lines covered (83.08%)

1689.82 hits per line

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

98.02

/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_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_DEPRECATED_RENDERER,
        NO_DIRECT_DATATYPE_ACCESS,
        NO_DIRECT_ENUM_ACCESS,
        NO_GLOBALS,
        NO_ICON_POOL_RENDERER,
        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,
        MISSING_CONTROL_RENDERER_DECLARATION,
        CONTROL_RENDERER_DECLARATION_STRING,
}
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_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_DEPRECATED_RENDERER]: {
                severity: LintMessageSeverity.Error,
                ruleId: RULES["no-deprecated-api"],

                message: () =>
                        `Use of deprecated renderer. Define explicitly {apiVersion: 2} parameter in renderer object`,
                details: () => `"{@link topic:c9ab34570cc14ea5ab72a6d1a4a03e3f Renderer Object}",`,
        },

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

                message: () =>
                        `"sap/ui/core/IconPool" module must be imported when using RenderManager's icon() method`,
                details: () => `"{@link sap.ui.core.RenderManager#methods/icon RenderManager}",`,
        },

        [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}`,
        },

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

                message: ({className}: {className: string}) =>
                        `Control '${className}' is missing a renderer declaration`,
                details: ({className}: {className: string}) => `Not defining a 'renderer' for control '${className}' ` +
                        `may lead to synchronous loading of the '${className}Renderer' module. ` +
                        `If no renderer exists, set 'renderer: null'. Otherwise, either import the renderer module ` +
                        `and assign it to the 'renderer' property or implement the renderer inline.`,
        },

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

                message: ({className, rendererName}: {className: string; rendererName: string | undefined}) =>
                        `Deprecated declaration of renderer ${rendererName ? `'${rendererName}' ` : ""}for control '${className}'`,
                details: ({className, rendererName}: {className: string; rendererName: string | undefined}) => {
                        const rendererModuleName = rendererName ? `'${rendererName.replace(/\./g, "/")}'` : "renderer";
                        return `Defining the 'renderer' for control '${className}' by its name may lead to synchronous ` +
                                `loading of the ${rendererModuleName} module. ` +
                                `Import the ${rendererModuleName} module and assign it to the 'renderer' property.`;
                },
        },

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

SAP / ui5-linter / 11514284751

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