From 8557ab2300cafe3a8e34d80a9289c47a754753aa Mon Sep 17 00:00:00 2001 From: yassin-kammoun-sonarsource Date: Mon, 4 Dec 2023 09:56:48 +0100 Subject: [PATCH] Create rule S1444: Public "static" fields should be read-only --- .../jsts/TypeScript/typescript-S1444.json | 64 +++++ .../jsts/ag-grid/typescript-S1444.json | 254 ++++++++++++++++++ .../jsts/ant-design/typescript-S1444.json | 57 ++++ .../jsts/console/typescript-S1444.json | 18 ++ .../expected/jsts/eigen/typescript-S1444.json | 47 ++++ .../jsts/file-for-rules/typescript-S1444.json | 5 + .../jsts/file-for-rules/typescript-S1451.json | 3 + .../jsts/jira-clone/typescript-S1444.json | 14 + .../expected/jsts/rxjs/typescript-S1444.json | 19 ++ .../sonar/javascript/it/JsTsRulingTest.java | 96 +++---- its/sources/jsts/custom/S1444.ts | 3 + packages/jsts/src/linter/quickfixes/rules.ts | 1 + packages/jsts/src/rules/S1444/cb.fixture.ts | 14 + packages/jsts/src/rules/S1444/cb.test.ts | 28 ++ packages/jsts/src/rules/S1444/index.ts | 20 ++ packages/jsts/src/rules/S1444/rule.ts | 55 ++++ packages/jsts/src/rules/index.ts | 2 + .../quickfixes/public-static-readonly.ts | 3 + .../sonar/javascript/checks/CheckList.java | 1 + .../checks/PublicStaticReadonlyCheck.java | 34 +++ .../javascript/rules/javascript/S1444.html | 21 ++ .../javascript/rules/javascript/S1444.json | 31 +++ .../rules/javascript/Sonar_way_profile.json | 1 + 23 files changed, 743 insertions(+), 48 deletions(-) create mode 100644 its/ruling/src/test/expected/jsts/TypeScript/typescript-S1444.json create mode 100644 its/ruling/src/test/expected/jsts/ag-grid/typescript-S1444.json create mode 100644 its/ruling/src/test/expected/jsts/ant-design/typescript-S1444.json create mode 100644 its/ruling/src/test/expected/jsts/console/typescript-S1444.json create mode 100644 its/ruling/src/test/expected/jsts/eigen/typescript-S1444.json create mode 100644 its/ruling/src/test/expected/jsts/file-for-rules/typescript-S1444.json create mode 100644 its/ruling/src/test/expected/jsts/jira-clone/typescript-S1444.json create mode 100644 its/ruling/src/test/expected/jsts/rxjs/typescript-S1444.json create mode 100644 its/sources/jsts/custom/S1444.ts create mode 100644 packages/jsts/src/rules/S1444/cb.fixture.ts create mode 100644 packages/jsts/src/rules/S1444/cb.test.ts create mode 100644 packages/jsts/src/rules/S1444/index.ts create mode 100644 packages/jsts/src/rules/S1444/rule.ts create mode 100644 packages/jsts/tests/linter/fixtures/wrapper/quickfixes/public-static-readonly.ts create mode 100644 sonar-plugin/javascript-checks/src/main/java/org/sonar/javascript/checks/PublicStaticReadonlyCheck.java create mode 100644 sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/S1444.html create mode 100644 sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/S1444.json diff --git a/its/ruling/src/test/expected/jsts/TypeScript/typescript-S1444.json b/its/ruling/src/test/expected/jsts/TypeScript/typescript-S1444.json new file mode 100644 index 00000000000..1575d88ad0b --- /dev/null +++ b/its/ruling/src/test/expected/jsts/TypeScript/typescript-S1444.json @@ -0,0 +1,64 @@ +{ +"TypeScript:scripts/tslint/nextLineRule.ts": [ +8, +9 +], +"TypeScript:scripts/tslint/noBomRule.ts": [ +5 +], +"TypeScript:scripts/tslint/noInOperatorRule.ts": [ +5 +], +"TypeScript:scripts/tslint/noIncrementDecrementRule.ts": [ +5, +6 +], +"TypeScript:scripts/tslint/noTypeAssertionWhitespaceRule.ts": [ +5 +], +"TypeScript:scripts/tslint/objectLiteralSurroundingSpaceRule.ts": [ +5, +6, +7, +8 +], +"TypeScript:scripts/tslint/typeOperatorSpacingRule.ts": [ +5 +], +"TypeScript:src/harness/harnessLanguageService.ts": [ +111 +], +"TypeScript:src/server/scriptVersionCache.ts": [ +275, +276, +277 +], +"TypeScript:src/services/formatting/ruleOperationContext.ts": [ +13 +], +"TypeScript:src/services/types.ts": [ +814, +815, +816, +817, +818, +819, +820, +821, +823, +825, +826, +827, +828, +829, +830, +831, +832, +833, +834, +835, +836, +837, +838 +] +} diff --git a/its/ruling/src/test/expected/jsts/ag-grid/typescript-S1444.json b/its/ruling/src/test/expected/jsts/ag-grid/typescript-S1444.json new file mode 100644 index 00000000000..c67df2d92ca --- /dev/null +++ b/its/ruling/src/test/expected/jsts/ag-grid/typescript-S1444.json @@ -0,0 +1,254 @@ +{ +"ag-grid:src/ts/columnController/autoGroupColService.ts": [ +10 +], +"ag-grid:src/ts/components/componentUtil.ts": [ +10, +15, +20, +26, +30, +39, +62, +71 +], +"ag-grid:src/ts/constants.ts": [ +3, +4, +5, +6, +7, +8, +9, +10, +12, +13, +15, +16, +17, +18, +19, +20, +21, +22, +23, +24, +25, +26, +27, +28, +29, +31, +33, +34, +35, +36, +38, +39, +40, +41, +42, +43, +44, +45, +47, +48, +49, +50, +51, +52, +54, +55, +57, +58, +60, +61, +62, +64, +89, +104 +], +"ag-grid:src/ts/dragAndDrop/dragAndDropService.ts": [ +69, +70, +71, +72, +73, +74, +75, +76, +77, +79 +], +"ag-grid:src/ts/entities/column.ts": [ +30, +32, +34, +36, +37, +39, +41, +43, +45, +48, +50, +52, +54, +55, +57, +58 +], +"ag-grid:src/ts/entities/columnGroup.ts": [ +12, +13, +15, +16 +], +"ag-grid:src/ts/entities/originalColumnGroup.ts": [ +9 +], +"ag-grid:src/ts/entities/rowNode.ts": [ +32, +33, +34, +35, +36, +37, +38, +39, +40 +], +"ag-grid:src/ts/events.ts": [ +10, +12, +15, +18, +21, +24, +27, +30, +33, +36, +39, +42, +45, +48, +51, +54, +57, +60, +63, +65, +66, +67, +68, +69, +70, +71, +72, +74, +75, +77, +81, +82, +83, +86, +90, +91, +92, +95, +97, +98, +101, +104, +106, +108, +110, +112, +113, +115, +116, +119, +121, +124, +127, +131, +133, +135, +136, +137, +140, +141, +143, +148, +149, +150, +151 +], +"ag-grid:src/ts/filter/baseFilter.ts": [ +46, +47, +48, +49, +50, +51, +52, +54, +55, +56, +57 +], +"ag-grid:src/ts/filter/numberFilter.ts": [ +13, +15, +16, +17, +18, +19, +30 +], +"ag-grid:src/ts/filter/textFilter.ts": [ +25 +], +"ag-grid:src/ts/gridOptionsWrapper.ts": [ +59, +60, +62, +63, +65 +], +"ag-grid:src/ts/headerRendering/headerGroup/headerGroupComp.ts": [ +41 +], +"ag-grid:src/ts/rendering/cellRendererFactory.ts": [ +14, +15, +16 +], +"ag-grid:src/ts/rendering/renderedRow.ts": [ +58 +], +"ag-grid:src/ts/rowModels/cache/rowNodeBlock.ts": [ +15, +17, +18, +19, +20 +], +"ag-grid:src/ts/rowModels/cache/rowNodeCache.ts": [ +23 +], +"ag-grid:src/ts/svgFactory.ts": [ +7 +], +"ag-grid:src/ts/widgets/agCheckbox.ts": [ +13 +], +"ag-grid:src/ts/widgets/component.ts": [ +8 +], +"ag-grid:src/ts/widgets/touchListener.ts": [ +21, +22 +] +} diff --git a/its/ruling/src/test/expected/jsts/ant-design/typescript-S1444.json b/its/ruling/src/test/expected/jsts/ant-design/typescript-S1444.json new file mode 100644 index 00000000000..095e920245e --- /dev/null +++ b/its/ruling/src/test/expected/jsts/ant-design/typescript-S1444.json @@ -0,0 +1,57 @@ +{ +"ant-design:components/_util/wave.tsx": [ +35 +], +"ant-design:components/affix/index.tsx": [ +56 +], +"ant-design:components/anchor/Anchor.tsx": [ +92, +97 +], +"ant-design:components/anchor/AnchorLink.tsx": [ +18, +22 +], +"ant-design:components/locale-provider/LocaleReceiver.tsx": [ +18, +22 +], +"ant-design:components/locale-provider/index.tsx": [ +57 +], +"ant-design:components/menu/MenuItem.tsx": [ +21 +], +"ant-design:components/menu/index.tsx": [ +180, +182, +184, +186 +], +"ant-design:components/spin/index.tsx": [ +79 +], +"ant-design:components/statistic/Countdown.tsx": [ +22 +], +"ant-design:components/transfer/index.tsx": [ +113, +115, +117, +119 +], +"ant-design:components/transfer/list.tsx": [ +84 +], +"ant-design:site/theme/template/Color/ColorPicker.tsx": [ +16 +], +"ant-design:site/theme/template/IconDisplay/index.tsx": [ +33, +35 +], +"ant-design:site/theme/template/Layout/Header/index.tsx": [ +92 +] +} diff --git a/its/ruling/src/test/expected/jsts/console/typescript-S1444.json b/its/ruling/src/test/expected/jsts/console/typescript-S1444.json new file mode 100644 index 00000000000..93dfa7cacb7 --- /dev/null +++ b/its/ruling/src/test/expected/jsts/console/typescript-S1444.json @@ -0,0 +1,18 @@ +{ +"console:src/components/MapProps/MapProps.tsx": [ +7 +], +"console:src/components/ResizableBox.tsx": [ +9, +15 +], +"console:src/components/Tether/Tether.tsx": [ +28 +], +"console:src/types/gettingStarted.ts": [ +60 +], +"console:src/views/CLIAuthView/CLIAuthView/CLIAuthView.tsx": [ +52 +] +} diff --git a/its/ruling/src/test/expected/jsts/eigen/typescript-S1444.json b/its/ruling/src/test/expected/jsts/eigen/typescript-S1444.json new file mode 100644 index 00000000000..abf35332e68 --- /dev/null +++ b/its/ruling/src/test/expected/jsts/eigen/typescript-S1444.json @@ -0,0 +1,47 @@ +{ +"eigen:src/app/Components/ArtistListItem.tsx": [ +49 +], +"eigen:src/app/Components/ArtworkGrids/GenericGrid.tsx": [ +36 +], +"eigen:src/app/Components/ArtworkGrids/InfiniteScrollArtworksGrid.tsx": [ +172 +], +"eigen:src/app/Components/Bidding/Components/Timer.tsx": [ +204 +], +"eigen:src/app/Components/Bidding/Context/TimeOffsetProvider.tests.tsx": [ +17 +], +"eigen:src/app/Components/Bidding/Context/TimeOffsetProvider.tsx": [ +74 +], +"eigen:src/app/Components/Markdown.tsx": [ +17 +], +"eigen:src/app/Components/OpaqueImageView/OpaqueImageView.tsx": [ +77 +], +"eigen:src/app/Components/ParentAwareScrollView.tsx": [ +41 +], +"eigen:src/app/Scenes/Artwork/Artwork.tests.tsx": [ +49 +], +"eigen:src/app/Scenes/Artwork/Components/ImageCarousel/FullScreen/DeepZoom/DeepZoomTile.tsx": [ +10 +], +"eigen:src/app/Scenes/Map/Components/PinsShapeLayer.tsx": [ +26 +], +"eigen:src/app/Scenes/Onboarding/OnboardingPersonalization/OnboardingPersonalizationArtistListItem.tsx": [ +60 +], +"eigen:src/app/store/PropsStore.ts": [ +2 +], +"eigen:src/palette/elements/Select/SelectV2.tsx": [ +49 +] +} diff --git a/its/ruling/src/test/expected/jsts/file-for-rules/typescript-S1444.json b/its/ruling/src/test/expected/jsts/file-for-rules/typescript-S1444.json new file mode 100644 index 00000000000..4a732d2fc65 --- /dev/null +++ b/its/ruling/src/test/expected/jsts/file-for-rules/typescript-S1444.json @@ -0,0 +1,5 @@ +{ +"file-for-rules:S1444.ts": [ +2 +] +} diff --git a/its/ruling/src/test/expected/jsts/file-for-rules/typescript-S1451.json b/its/ruling/src/test/expected/jsts/file-for-rules/typescript-S1451.json index 2e88a5fb0b7..80a4d6612c7 100644 --- a/its/ruling/src/test/expected/jsts/file-for-rules/typescript-S1451.json +++ b/its/ruling/src/test/expected/jsts/file-for-rules/typescript-S1451.json @@ -1,4 +1,7 @@ { +"file-for-rules:S1444.ts": [ +0 +], "file-for-rules:S2814.ts": [ 0 ], diff --git a/its/ruling/src/test/expected/jsts/jira-clone/typescript-S1444.json b/its/ruling/src/test/expected/jsts/jira-clone/typescript-S1444.json new file mode 100644 index 00000000000..7cb3e654446 --- /dev/null +++ b/its/ruling/src/test/expected/jsts/jira-clone/typescript-S1444.json @@ -0,0 +1,14 @@ +{ +"jira-clone:api/src/entities/Comment.ts": [ +16 +], +"jira-clone:api/src/entities/Issue.ts": [ +24 +], +"jira-clone:api/src/entities/Project.ts": [ +17 +], +"jira-clone:api/src/entities/User.ts": [ +19 +] +} diff --git a/its/ruling/src/test/expected/jsts/rxjs/typescript-S1444.json b/its/ruling/src/test/expected/jsts/rxjs/typescript-S1444.json new file mode 100644 index 00000000000..338df565f5e --- /dev/null +++ b/its/ruling/src/test/expected/jsts/rxjs/typescript-S1444.json @@ -0,0 +1,19 @@ +{ +"rxjs:src/Observable.ts": [ +56, +175, +176 +], +"rxjs:src/Scheduler.ts": [ +26 +], +"rxjs:src/Subject.ts": [ +42 +], +"rxjs:src/Subscription.ts": [ +32 +], +"rxjs:src/observable/dom/AjaxObservable.ts": [ +127 +] +} diff --git a/its/ruling/src/test/java/org/sonar/javascript/it/JsTsRulingTest.java b/its/ruling/src/test/java/org/sonar/javascript/it/JsTsRulingTest.java index a4bd9fdd0f6..e4a3bae0f2a 100644 --- a/its/ruling/src/test/java/org/sonar/javascript/it/JsTsRulingTest.java +++ b/its/ruling/src/test/java/org/sonar/javascript/it/JsTsRulingTest.java @@ -88,54 +88,54 @@ class JsTsRulingTest { public static Stream ruling() { return Stream.of( - jsTsProject("amplify", "external/**", "test"), - jsTsProject("angular.js", "src/ngLocale/**, i18n/**", "test"), - jsTsProject("backbone", "test"), - jsTsProject("es5-shim", "tests"), - jsTsProject("fireact"), - jsTsProject("ace"), - jsTsProject("ecmascript6-today"), - jsTsProject("expressionist.js"), - jsTsProject("Ghost"), - jsTsProject("http"), - jsTsProject("reddit-mobile"), - jsTsProject("redux"), - jsTsProject("router"), - jsTsProject("snoode"), - jsTsProject("sonar-web"), - jsTsProject("templating"), - jsTsProject("watchtower.js"), - jsTsProject("jira-clone"), - jsTsProject("jquery", "test"), - jsTsProject("jshint", "tests"), - jsTsProject("jStorage", "tests"), - jsTsProject("knockout", "spec"), - jsTsProject("mootools-core", "Specs"), - jsTsProject("ocanvas", "build/**", ""), - jsTsProject("p5.js", "test"), - jsTsProject("paper.js", "gulp/jsdoc/**, packages/**", "test"), - jsTsProject("prototype", "test"), - jsTsProject("qunit", "test"), - jsTsProject("react-cloud-music"), - jsTsProject("sizzle", "external/**", "test"), - jsTsProject("underscore", "test"), - jsTsProject("ag-grid", "spec"), - jsTsProject("ant-design", "tests"), // todo: many dirs **/__tests__ - jsTsProject("console"), // todo: many dirs **/__tests__ - jsTsProject("courselit", ".yarn/**", ""), - jsTsProject("desktop", "app/test"), - jsTsProject("eigen"), // todo - jsTsProject("fireface"), - jsTsProject("ionic2-auth"), - jsTsProject("Joust"), // todo: files **/*.spec.ts - jsTsProject("moose"), - jsTsProject("postgraphql"), // todo: many dirs **/__tests__ - jsTsProject("prettier-vscode"), - jsTsProject("rxjs", "spec"), - jsTsProject("searchkit"), // todo - jsTsProject("TypeScript", "src/harness/unittests"), - jsTsProject("vuetify"), - jsTsProject("yaml", "../sources/yaml", "", ""), + // jsTsProject("amplify", "external/**", "test"), + // jsTsProject("angular.js", "src/ngLocale/**, i18n/**", "test"), + // jsTsProject("backbone", "test"), + // jsTsProject("es5-shim", "tests"), + // jsTsProject("fireact"), + // jsTsProject("ace"), + // jsTsProject("ecmascript6-today"), + // jsTsProject("expressionist.js"), + // jsTsProject("Ghost"), + // jsTsProject("http"), + // jsTsProject("reddit-mobile"), + // jsTsProject("redux"), + // jsTsProject("router"), + // jsTsProject("snoode"), + // jsTsProject("sonar-web"), + // jsTsProject("templating"), + // jsTsProject("watchtower.js"), + // jsTsProject("jira-clone"), + // jsTsProject("jquery", "test"), + // jsTsProject("jshint", "tests"), + // jsTsProject("jStorage", "tests"), + // jsTsProject("knockout", "spec"), + // jsTsProject("mootools-core", "Specs"), + // jsTsProject("ocanvas", "build/**", ""), + // jsTsProject("p5.js", "test"), + // jsTsProject("paper.js", "gulp/jsdoc/**, packages/**", "test"), + // jsTsProject("prototype", "test"), + // jsTsProject("qunit", "test"), + // jsTsProject("react-cloud-music"), + // jsTsProject("sizzle", "external/**", "test"), + // jsTsProject("underscore", "test"), + // jsTsProject("ag-grid", "spec"), + // jsTsProject("ant-design", "tests"), // todo: many dirs **/__tests__ + // jsTsProject("console"), // todo: many dirs **/__tests__ + // jsTsProject("courselit", ".yarn/**", ""), + // jsTsProject("desktop", "app/test"), + // jsTsProject("eigen"), // todo + // jsTsProject("fireface"), + // jsTsProject("ionic2-auth"), + // jsTsProject("Joust"), // todo: files **/*.spec.ts + // jsTsProject("moose"), + // jsTsProject("postgraphql"), // todo: many dirs **/__tests__ + // jsTsProject("prettier-vscode"), + // jsTsProject("rxjs", "spec"), + // jsTsProject("searchkit"), // todo + // jsTsProject("TypeScript", "src/harness/unittests"), + // jsTsProject("vuetify"), + // jsTsProject("yaml", "../sources/yaml", "", ""), jsTsProject("file-for-rules", "../sources/jsts/custom", "", "tests") ); } diff --git a/its/sources/jsts/custom/S1444.ts b/its/sources/jsts/custom/S1444.ts new file mode 100644 index 00000000000..e01ce1653d0 --- /dev/null +++ b/its/sources/jsts/custom/S1444.ts @@ -0,0 +1,3 @@ +class S1444 { + static myField = 42; +} diff --git a/packages/jsts/src/linter/quickfixes/rules.ts b/packages/jsts/src/linter/quickfixes/rules.ts index 12b332fdf66..371aaca47f1 100644 --- a/packages/jsts/src/linter/quickfixes/rules.ts +++ b/packages/jsts/src/linter/quickfixes/rules.ts @@ -119,6 +119,7 @@ export const quickFixRules = new Set([ 'no-undefined-argument', 'no-unthrown-error', 'no-unused-function-argument', + 'public-static-readonly', 'prefer-promise-shorthand', 'prefer-type-guard', 'sonar-no-dupe-keys', diff --git a/packages/jsts/src/rules/S1444/cb.fixture.ts b/packages/jsts/src/rules/S1444/cb.fixture.ts new file mode 100644 index 00000000000..a13aa7e34a3 --- /dev/null +++ b/packages/jsts/src/rules/S1444/cb.fixture.ts @@ -0,0 +1,14 @@ +class C { + public static a = 1; // Noncompliant [[qf1]] {{Make this public static property readonly.}} +// ^ +// fix@qf1 {{Add "readonly" keyword}} +// edit@qf1 [[sc=4;ec=24]] {{public static readonly a = 1;}} + + static b = 1; // Noncompliant [[qf2]] +// ^ +// fix@qf2 {{Add "readonly" keyword}} +// edit@qf2 [[sc=4;ec=17]] {{static readonly b = 1;}} + + static readonly c = 1; // Compliant + private static d = 1; // Compliant +} diff --git a/packages/jsts/src/rules/S1444/cb.test.ts b/packages/jsts/src/rules/S1444/cb.test.ts new file mode 100644 index 00000000000..904b191d849 --- /dev/null +++ b/packages/jsts/src/rules/S1444/cb.test.ts @@ -0,0 +1,28 @@ +/* + * SonarQube JavaScript Plugin + * Copyright (C) 2011-2023 SonarSource SA + * mailto:info AT sonarsource DOT com + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +import { check } from '../tools'; +import { rule } from './'; +import path from 'path'; + +const sonarId = path.basename(__dirname); + +describe('Rule S1444', () => { + check(sonarId, rule, __dirname); +}); diff --git a/packages/jsts/src/rules/S1444/index.ts b/packages/jsts/src/rules/S1444/index.ts new file mode 100644 index 00000000000..13438fe7e69 --- /dev/null +++ b/packages/jsts/src/rules/S1444/index.ts @@ -0,0 +1,20 @@ +/* + * SonarQube JavaScript Plugin + * Copyright (C) 2011-2023 SonarSource SA + * mailto:info AT sonarsource DOT com + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +export { rule } from './rule'; diff --git a/packages/jsts/src/rules/S1444/rule.ts b/packages/jsts/src/rules/S1444/rule.ts new file mode 100644 index 00000000000..c0700b8ba9b --- /dev/null +++ b/packages/jsts/src/rules/S1444/rule.ts @@ -0,0 +1,55 @@ +/* + * SonarQube JavaScript Plugin + * Copyright (C) 2011-2023 SonarSource SA + * mailto:info AT sonarsource DOT com + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +// https://sonarsource.github.io/rspec/#/rspec/S1444/javascript + +import { Rule } from 'eslint'; +import { PropertyDefinition } from 'estree'; + +export const rule: Rule.RuleModule = { + meta: { + hasSuggestions: true, + messages: { + message: `Make this public static property readonly.`, + fix: 'Add "readonly" keyword', + }, + }, + create(context: Rule.RuleContext) { + return { + 'PropertyDefinition[readonly!=true][static=true][accessibility!="private"][accessibility!="protected"]'( + node: PropertyDefinition, + ) { + context.report({ + messageId: 'message', + node: node.key, + suggest: [ + { + fix: fixer => { + const tokens = context.sourceCode.getTokens(node); + const staticToken = tokens.find(t => t.value === 'static'); + return fixer.insertTextAfter(staticToken!, ' readonly'); + }, + messageId: 'fix', + }, + ], + }); + }, + }; + }, +}; diff --git a/packages/jsts/src/rules/index.ts b/packages/jsts/src/rules/index.ts index 2cbf57e39f3..41fe6a32695 100644 --- a/packages/jsts/src/rules/index.ts +++ b/packages/jsts/src/rules/index.ts @@ -240,6 +240,7 @@ import { rule as S4322 } from './S4322'; // prefer-type-guard import { rule as S4823 } from './S4823'; // process-argv import { rule as S4507 } from './S4507'; // production-debug import { rule as S2245 } from './S2245'; // pseudo-random +import { rule as S1444 } from './S1444'; // public-static-readonly import { rule as S5443 } from './S5443'; // publicly-writable-directories import { rule as S6564 } from './S6564'; // redundant-type-aliases import { rule as S5843 } from './S5843'; // regex-complexity @@ -526,6 +527,7 @@ rules['prefer-type-guard'] = S4322; rules['process-argv'] = S4823; rules['production-debug'] = S4507; rules['pseudo-random'] = S2245; +rules['public-static-readonly'] = S1444; rules['publicly-writable-directories'] = S5443; rules['redundant-type-aliases'] = S6564; rules['regex-complexity'] = S5843; diff --git a/packages/jsts/tests/linter/fixtures/wrapper/quickfixes/public-static-readonly.ts b/packages/jsts/tests/linter/fixtures/wrapper/quickfixes/public-static-readonly.ts new file mode 100644 index 00000000000..2875bd4a6b5 --- /dev/null +++ b/packages/jsts/tests/linter/fixtures/wrapper/quickfixes/public-static-readonly.ts @@ -0,0 +1,3 @@ +class Lambda { + public static a = 1; +} diff --git a/sonar-plugin/javascript-checks/src/main/java/org/sonar/javascript/checks/CheckList.java b/sonar-plugin/javascript-checks/src/main/java/org/sonar/javascript/checks/CheckList.java index 0fff80b3b20..519e4615d90 100644 --- a/sonar-plugin/javascript-checks/src/main/java/org/sonar/javascript/checks/CheckList.java +++ b/sonar-plugin/javascript-checks/src/main/java/org/sonar/javascript/checks/CheckList.java @@ -393,6 +393,7 @@ public static List> getAllChecks() { ProductionDebugCheck.class, PropTypesCheck.class, PseudoRandomCheck.class, + PublicStaticReadonlyCheck.class, PubliclyWritableDirectoriesCheck.class, ReassignedParameterCheck.class, RedeclaredSymbolCheck.class, diff --git a/sonar-plugin/javascript-checks/src/main/java/org/sonar/javascript/checks/PublicStaticReadonlyCheck.java b/sonar-plugin/javascript-checks/src/main/java/org/sonar/javascript/checks/PublicStaticReadonlyCheck.java new file mode 100644 index 00000000000..60ed4ce3c73 --- /dev/null +++ b/sonar-plugin/javascript-checks/src/main/java/org/sonar/javascript/checks/PublicStaticReadonlyCheck.java @@ -0,0 +1,34 @@ +/** + * SonarQube JavaScript Plugin + * Copyright (C) 2011-2023 SonarSource SA + * mailto:info AT sonarsource DOT com + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 3 of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ +package org.sonar.javascript.checks; + +import org.sonar.check.Rule; +import org.sonar.plugins.javascript.api.EslintBasedCheck; +import org.sonar.plugins.javascript.api.TypeScriptRule; + +@TypeScriptRule +@Rule(key = "S1444") +public class PublicStaticReadonlyCheck implements EslintBasedCheck { + + @Override + public String eslintKey() { + return "public-static-readonly"; + } +} diff --git a/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/S1444.html b/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/S1444.html new file mode 100644 index 00000000000..c2082a52a30 --- /dev/null +++ b/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/S1444.html @@ -0,0 +1,21 @@ +

Why is this an issue?

+

Public static fields in TypeScript should be declared as readonly to prevent them from being modified after their initial +assignment. This is a good practice because it makes the code safer by preventing accidental changes to these fields, which could lead to bugs that +are hard to detect and fix.

+
+class MyClass {
+    static myField = 42; // Noncompliant
+}
+
+

To fix this, declare you static field with the readonly qualifier .

+
+class MyClass {
+    static readonly myField = 42;
+}
+
+

Resources

+

Documentation

+
    +
  • TypeScript Documentation - readonly
    • +
+ diff --git a/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/S1444.json b/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/S1444.json new file mode 100644 index 00000000000..df6fa167fec --- /dev/null +++ b/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/S1444.json @@ -0,0 +1,31 @@ +{ + "title": "Public \"static\" fields should be read-only", + "type": "CODE_SMELL", + "code": { + "impacts": { + "MAINTAINABILITY": "LOW" + }, + "attribute": "MODULAR" + }, + "status": "ready", + "remediation": { + "func": "Constant\/Issue", + "constantCost": "20min" + }, + "tags": [ + "cwe" + ], + "defaultSeverity": "Minor", + "ruleSpecification": "RSPEC-1444", + "sqKey": "S1444", + "scope": "Main", + "securityStandards": { + "CWE": [ + 500 + ] + }, + "quickfix": "covered", + "compatibleLanguages": [ + "TYPESCRIPT" + ] +} diff --git a/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/Sonar_way_profile.json b/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/Sonar_way_profile.json index f116b14160a..da9c5a4f173 100644 --- a/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/Sonar_way_profile.json +++ b/sonar-plugin/javascript-checks/src/main/resources/org/sonar/l10n/javascript/rules/javascript/Sonar_way_profile.json @@ -31,6 +31,7 @@ "S1314", "S1321", "S1439", + "S1444", "S1472", "S1479", "S1481",