You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@ozone.apache.org by "yuriipalam (via GitHub)" <gi...@apache.org> on 2026/03/05 11:31:27 UTC

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

yuriipalam opened a new pull request, #359:
URL: https://github.com/apache/ozone-site/pull/359

## What changes were proposed in this pull request?

Integrate ESLint into the project.

[ESLint](https://eslint.org/) 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](https://docusaurus.io/docs/api/misc/@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](https://issues.apache.org/jira/browse/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
- [X] I verified the rendered content using a local preview
- [X] I manually verified the steps provided in this change work as described

--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org

Re: [PR] HDDS-14770. [Website] Integrate eslint and run it in github actions [ozone-site]

Posted by "errose28 (via GitHub)" <gi...@apache.org>.

errose28 commented on code in PR #359:
URL: https://github.com/apache/ozone-site/pull/359#discussion_r2920153340


##########
eslint.config.mjs:
##########
@@ -0,0 +1,170 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import js from "@eslint/js";
+import globals from "globals";
+import pluginReact from "eslint-plugin-react";
+import css from "@eslint/css";
+import { defineConfig } from "eslint/config";
+import pluginDocusaurus from "@docusaurus/eslint-plugin";
+import pluginUnusedImports from "eslint-plugin-unused-imports";
+import pluginImport from "eslint-plugin-import";
+
+const apacheLicenseRule = {
+  meta: {
+    type: "problem",
+    docs: {
+      description: "Enforce Apache License header in source files",
+    },
+    fixable: "code",
+    messages: {
+      missingHeader: "Missing Apache License header at the top of the file",
+    },
+  },
+  create(context) {
+    const REQUIRED_HEADER = `/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */`;
+
+    return {
+      Program(node) {
+        const sourceCode = context.sourceCode || context.getSourceCode();
+        const text = sourceCode.getText();
+
+        if (!text.startsWith(REQUIRED_HEADER)) {
+          context.report({
+            node,
+            messageId: "missingHeader",
+            fix(fixer) {
+              return fixer.insertTextBefore(node, REQUIRED_HEADER + "\n\n");
+            },
+          });
+        }
+      },
+    };
+  },
+};
+
+export default defineConfig([
+  // General
+  {
+    ignores: [
+      "static/**",
+      "node_modules/**",
+      "build/**",
+      "dist/**",
+      ".docusaurus/**",
+      ".github/**",
+    ],
+  },
+
+  // JS
+  {
+    files: ["**/*.{js,mjs,cjs,jsx}"],
+    ...js.configs.recommended,
+    languageOptions: { globals: { ...globals.browser, ...globals.node } },
+    plugins: {
+      "unused-imports": pluginUnusedImports,
+      import: pluginImport,
+    },
+    rules: {
+      "unused-imports/no-unused-imports": "error",
+      // unused vars (but ignore underscore-prefixed)
+      "unused-imports/no-unused-vars": [
+        "warn",
+        {
+          vars: "all",
+          varsIgnorePattern: "^_",
+          args: "after-used",
+          argsIgnorePattern: "^_",
+        },
+      ],
+      "import/no-duplicates": "error",
+      "no-unused-vars": "off",
+    },
+  },
+
+  // React
+  {
+    files: ["**/*.{js,jsx}"],
+    ...pluginReact.configs.flat.recommended,
+    settings: {
+      react: { version: "detect" },
+    },
+    rules: {
+      "react/prop-types": "off",
+      "react/react-in-jsx-scope": "off",
+      "react/jsx-uses-vars": "error",
+    },
+  },
+
+  // CSS
+  {
+    files: ["**/*.css"],
+    plugins: { css },
+    language: "css/css",
+    extends: ["css/recommended"],
+    rules: {
+      "css/no-invalid-properties": "off",
+      "css/no-important": "off",
+      "css/use-baseline": "off",
+    },
+  },
+
+  // Docusaurus
+  {
+    files: ["**/*.{js,mjs,cjs,jsx}"],
+    plugins: { "@docusaurus": pluginDocusaurus },
+    rules: {
+      "@docusaurus/no-html-links": "error",
+      "@docusaurus/prefer-docusaurus-heading": "error",
+      "@docusaurus/string-literal-i18n-messages": "error",
+      // for i18n
+      // "@docusaurus/no-untranslated-text": ["warn", { ignoredStrings: [] }]

Review Comment:
   In that case we can probably use this block instead of manually defining the rules so we automatically pick up new rules if Docusaurus adds them later:
   ```
   {
     "extends": ["plugin:@docusaurus/recommended"]
   }
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org