HDDS-14770. [Website] Integrate eslint and run it in github actions by yuriipalam · Pull Request #359 · apache/ozone-site

yuriipalam · 2026-03-05T11:31:24Z

What changes were proposed in this pull request?

Integrate ESLint into the project.

ESLint is a static code analyzer, so now we have analyzer during the development.

Both tools were integrated, as well as relevant extensions to them, e.g., Docusaurus ESLint plugin

Fixed all the issues that the code analyzers found. Some files had .js extension, while they are supposed to have .jsx extension, since they have React code inside.

pnpm run lint now runs eslint as well.
pnpm run lint:fix now applies auto-fixes from ESLint as well.

Strongly recommend you to check eslint.config.mjs, since it sets up the code rules for the project. I also added a custom rule that enforces the license header.

I also updated CONTRIBUTE.MD accordingly, the "Quick Start" section and added a new "Linting and Formatting" section.

What is the link to the Apache Jira?

HDDS-14770

How was this patch tested?

Check off which of the following tests were done on this change. If additional testing was done, please elaborate here as well.

The CI checks on my fork are passing
I verified the rendered content using a local preview
I manually verified the steps provided in this change work as described

devabhishekpal · 2026-03-05T11:39:18Z

Thanks a lot for this much needed change @yuriipalam.
Can you please add the rules for using single quotes, spacing between brackets and arrow functions to have brackets always?

I am not sure if this is being currently used or if it would be used in the future, but enforcing this would be great.

yuriipalam · 2026-03-05T13:49:40Z

@devabhishekpal thanks for the review.

For this I'm planning to add Prettier in the next PR. It enforces all the code formatting rules, so they are consistent. What you said could be also enforced by eslint alone, but since I'm planning to add Prettier in the subsequent PR, it's better to do it there. I'll enforce exactly what you've requested.

devabhishekpal

Thanks for the patch @yuriipalam.
This LGTM, +1

errose28

Thanks for adding this @yuriipalam

errose28 · 2026-03-05T17:29:11Z

package.json

+    "lint": "eslint . && markdownlint \"$(git rev-parse --show-toplevel)\" && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"",
+    "lint:fix": "eslint --fix . && markdownlint --fix \"$(git rev-parse --show-toplevel)\" && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""


After some testing, it looks like the . is always resolved to the repo root regardless of which tool is used. Also switching && for ; lets us run all linters at once instead of stopping when the first one hits an error.

Suggested change

"lint": "eslint . && markdownlint \"$(git rev-parse --show-toplevel)\" && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"",

"lint:fix": "eslint --fix . && markdownlint --fix \"$(git rev-parse --show-toplevel)\" && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""

"lint": "eslint . ; markdownlint . ; yamllint --format=colored .",

"lint:fix": "eslint --fix . ; markdownlint --fix . ; yamllint --format=colored ."

To test this I added this diff and ran pnpm lint from the docs directory, which is lower in the directory tree than any of these changes. Linting errors on all three files were correctly flagged.

diff --git a/compose.yml b/compose.yml index 1a6c84659..32e67770b 100644 --- a/compose.yml +++ b/compose.yml @@ -17,7 +17,7 @@ version: "3" services: site: - build: . + build: . image: ozone-site ports: - 3001:3001 diff --git a/package.json b/package.json index 4277cbaf5..e0739a14b 100644 --- a/package.json +++ b/package.json @@ -13,8 +13,8 @@ "serve": "docusaurus serve --port 3001", "write-translations": "docusaurus write-translations", "write-heading-ids": "docusaurus write-heading-ids", - "lint": "eslint . && markdownlint \"$(git rev-parse --show-toplevel)\" && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"", - "lint:fix": "eslint --fix . && markdownlint --fix \"$(git rev-parse --show-toplevel)\" && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"" + "lint": "eslint . ; markdownlint . ; yamllint --format=colored .", + "lint:fix": "eslint --fix . ; markdownlint --fix . ; yamllint --format=colored ." }, "dependencies": { "@docusaurus/core": "3.7.0", diff --git a/src/pages/download.md b/src/pages/download.md index 2fefd7658..c543ef39e 100644 --- a/src/pages/download.md +++ b/src/pages/download.md @@ -6,7 +6,7 @@ | 2.0.0 | 2025 Apr 30 | [Source](https://www.apache.org/dyn/closer.cgi/ozone/2.0.0/ozone-2.0.0-src.tar.gz) [Checksum](https://downloads.apache.org/ozone/2.0.0/ozone-2.0.0-src.tar.gz.sha512) [Signature](https://downloads.apache.org/ozone/2.0.0/ozone-2.0.0-src.tar.gz.asc) | [Binary](https://www.apache.org/dyn/closer.cgi/ozone/2.0.0/ozone-2.0.0.tar.gz) [Checksum](https://downloads.apache.org/ozone/2.0.0/ozone-2.0.0.tar.gz.sha512) [Signature](https://downloads.apache.org/ozone/2.0.0/ozone-2.0.0.tar.gz.asc) | [Release Notes](/release-notes/2.0.0) | | 1.4.1 | 2024 Nov 24 | [Source](https://www.apache.org/dyn/closer.cgi/ozone/1.4.1/ozone-1.4.1-src.tar.gz) [Checksum](https://downloads.apache.org/ozone/1.4.1/ozone-1.4.1-src.tar.gz.sha512) [Signature](https://downloads.apache.org/ozone/1.4.1/ozone-1.4.1-src.tar.gz.asc) | [Binary](https://www.apache.org/dyn/closer.cgi/ozone/1.4.1/ozone-1.4.1.tar.gz) [Checksum](https://downloads.apache.org/ozone/1.4.1/ozone-1.4.1.tar.gz.sha512) [Signature](https://downloads.apache.org/ozone/1.4.1/ozone-1.4.1.tar.gz.asc) | [Release Notes](/release-notes/1.4.1) | -## Archives +### Archives Older releases are available from the [Apache Ozone archive](https://archive.apache.org/dist/ozone/). diff --git a/src/theme/DocSidebar/index.module.css b/src/theme/DocSidebar/index.module.css index 39601f08f..c3d7447af 100644 --- a/src/theme/DocSidebar/index.module.css +++ b/src/theme/DocSidebar/index.module.css @@ -48,6 +48,6 @@ aside .customSidebarInner { aside .customSidebarVersion p { margin-bottom: 0; - font-size: var(--fbc-font-size, 13px); + font-size: var(--fbc-font-size: 13px;); padding: var(--ifm-menu-link-padding-vertical) var(--ifm-menu-link-padding-horizontal); }

errose28 · 2026-03-05T17:37:30Z

eslint.config.mjs

+      "static/**",
+      "node_modules/**",
+      "build/**",
+      "dist/**",


I don't see a dist directory in the repo. Does something generate this?

errose28 · 2026-03-05T17:38:23Z

eslint.config.mjs

+      "unused-imports/no-unused-imports": "error",
+      // unused vars (but ignore underscore-prefixed)
+      "unused-imports/no-unused-vars": [
+        "warn",


I don't think warning are useful, people will only check if the command passes or fails. If we care about something we should make it an error. Unused variables should fail linting I think.

errose28 · 2026-03-05T17:47:16Z

eslint.config.mjs

+  // Custom rule to enforce Apache License header
+  {
+    files: ["**/*.{js,mjs,cjs,jsx}"],


I don't think we need this. We already have a license header check using skywalking-eyes for all files in CI which is more robust than this strict string constant header check. This does run locally on pnpm lint which is nice, but it only checks javascript files which are rarely modified. I don't think we would want to expand the scope to other file types since it's more brittle than skywalking eyes anyways.

I think we can remove this to keep our linting config simple and reduce duplication/conflicts with skywalking-eyes. In a follow-up change it would be good to have skywalking-eyes run locally on lint too, but that would also require a separate install outside of node.js.

errose28 · 2026-03-05T17:49:52Z

eslint.config.mjs

+      "unused-imports": pluginUnusedImports,
+      import: pluginImport,
+    },
+    rules: {


Do we want to add a rule to enforce import order?

errose28 · 2026-03-05T17:52:36Z

eslint.config.mjs

+      "@docusaurus/prefer-docusaurus-heading": "error",
+      "@docusaurus/string-literal-i18n-messages": "error",
+      // for i18n
+      // "@docusaurus/no-untranslated-text": ["warn", { ignoredStrings: [] }]


Does this rule fail even if i18n is disabled? If it passes trivially in this case then we can probably reduce this to just use the default recommended config instead of specifying rules individually.

errose28 · 2026-03-05T17:54:28Z

eslint.config.mjs

+  {
+    files: ["**/*.{js,mjs,cjs,jsx}"],
+    ...js.configs.recommended,
+    languageOptions: { globals: { ...globals.browser, ...globals.node } },


Cursor made this suggestion, although I don't know enough about javascript to really understand the implications:

Medium: browser and node globals are both enabled for all JS files, which can hide environment mistakes.
This permits Node globals in browser code and browser globals in Node-only files without lint failures.
Better practice is split overrides by file location (src/** browser, config/scripts Node).

files: ["**/*.{js,mjs,cjs,jsx}"], ...js.configs.recommended, languageOptions: { globals: { ...globals.browser, ...globals.node } }, plugins: { "unused-imports": pluginUnusedImports, import: pluginImport, }, files: ["**/*.{js,mjs,cjs,jsx}"],...js.configs.recommended,languageOptions: { globals: { ...globals.browser, ...globals.node } },plugins: { "unused-imports": pluginUnusedImports, import: pluginImport,},

HDDS-14770. [Website] Integrate eslint and run it in github actions

4dbe3f5

devabhishekpal self-requested a review March 5, 2026 11:39

Do not ignore config files

5ecdae7

devabhishekpal approved these changes Mar 5, 2026

View reviewed changes

devabhishekpal requested review from errose28 and jojochuang March 5, 2026 16:52

errose28 reviewed Mar 5, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HDDS-14770. [Website] Integrate eslint and run it in github actions#359

HDDS-14770. [Website] Integrate eslint and run it in github actions#359
yuriipalam wants to merge 2 commits intoapache:masterfrom
yuriipalam:HDDS-14770

yuriipalam commented Mar 5, 2026 •

edited

Loading

Uh oh!

devabhishekpal commented Mar 5, 2026

Uh oh!

yuriipalam commented Mar 5, 2026

Uh oh!

devabhishekpal left a comment

Uh oh!

errose28 left a comment

Uh oh!

errose28 Mar 5, 2026

Uh oh!

errose28 Mar 5, 2026

Uh oh!

errose28 Mar 5, 2026

Uh oh!

errose28 Mar 5, 2026

Uh oh!

errose28 Mar 5, 2026

Uh oh!

errose28 Mar 5, 2026

Uh oh!

errose28 Mar 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		"lint": "eslint . && markdownlint \"$(git rev-parse --show-toplevel)\" && yamllint --format=colored \"$(git rev-parse --show-toplevel)\"",
		"lint:fix": "eslint --fix . && markdownlint --fix \"$(git rev-parse --show-toplevel)\" && yamllint --format=colored \"$(git rev-parse --show-toplevel)\""

Conversation

yuriipalam commented Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What changes were proposed in this pull request?

What is the link to the Apache Jira?

How was this patch tested?

Uh oh!

devabhishekpal commented Mar 5, 2026

Uh oh!

yuriipalam commented Mar 5, 2026

Uh oh!

devabhishekpal left a comment

Choose a reason for hiding this comment

Uh oh!

errose28 left a comment

Choose a reason for hiding this comment

Uh oh!

errose28 Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

errose28 Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

errose28 Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

errose28 Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

errose28 Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

errose28 Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

errose28 Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yuriipalam commented Mar 5, 2026 •

edited

Loading