Format .md, .json, .yaml files using prettier (mlflow#7429)

* Add config

Signed-off-by: harupy <[email protected]>

* Format .md, .json, .yaml files using prettier

Signed-off-by: harupy <[email protected]>

* Format JS files

Signed-off-by: harupy <[email protected]>

* Ignore failure

Signed-off-by: harupy <[email protected]>

Signed-off-by: harupy <[email protected]>

Author: harupy

.devcontainer/docker-compose.yml

@@ -1,7 +1,7 @@
-version: '3'
+version: "3"
 services:
   mlflow:
-    image: 'ghcr.io/mlflow/mlflow-devcontainer'
+    image: "ghcr.io/mlflow/mlflow-devcontainer"
     working_dir: /workspaces/mlflow
     environment:
       MLFLOW_HOME: /workspaces/mlflow

.github/ISSUE_TEMPLATE/bug_report_template.yaml

@@ -1,7 +1,7 @@
 name: Bug Report
 description: Create a report to help us reproduce and correct the bug
-labels: 'bug'
-title: '[BUG]'
+labels: "bug"
+title: "[BUG]"
 
 body:
   - type: markdown

.github/ISSUE_TEMPLATE/doc_fix_template.yaml

@@ -1,7 +1,7 @@
 name: Documentation Fix
 description: Use this template for proposing documentation fixes/improvements.
-labels: 'area/docs'
-title: '[DOC-FIX]'
+labels: "area/docs"
+title: "[DOC-FIX]"
 
 body:
   - type: markdown

.github/ISSUE_TEMPLATE/feature_request_template.yaml

@@ -1,7 +1,7 @@
 name: Feature Request
 description: Use this template for feature and enhancement proposals.
-labels: 'enhancement'
-title: '[FR]'
+labels: "enhancement"
+title: "[FR]"
 
 body:
   - type: markdown

.github/ISSUE_TEMPLATE/installation_issue_template.yaml

@@ -1,7 +1,7 @@
 name: Installation Issues
 description: Use this template for reporting bugs encountered while installing MLflow.
-labels: 'bug'
-title: '[SETUP-BUG]'
+labels: "bug"
+title: "[SETUP-BUG]"
 
 body:
   - type: markdown

.github/ISSUE_TEMPLATE/ui_bug_report_template.yaml

@@ -1,7 +1,7 @@
 name: UI Bug Report
 description: Create a report to help us reproduce and correct the UI bug
-labels: ['bug', 'area/uiux']
-title: '[BUG]'
+labels: ["bug", "area/uiux"]
+title: "[BUG]"
 
 body:
   - type: markdown

.github/actions/setup-java/action.yml

@@ -1,18 +1,18 @@
-name: 'setup-java'
-description: 'Set up Java'
+name: "setup-java"
+description: "Set up Java"
 inputs:
   java-version:
-    description: 'java-version'
+    description: "java-version"
     default: 11
     required: false
 
   distribution:
-    description: 'distribution'
+    description: "distribution"
     default: adopt
     required: false
 
 runs:
-  using: 'composite'
+  using: "composite"
   steps:
     - uses: actions/setup-java@v3
       with:

.github/actions/update-requirements/action.yml

@@ -1,13 +1,13 @@
-name: 'update-requirements'
-description: 'Update requirements YAML specifications and re-generate requirements text files'
+name: "update-requirements"
+description: "Update requirements YAML specifications and re-generate requirements text files"
 
 outputs:
   updated:
-    description: 'Indicates whether the requirements have been updated'
+    description: "Indicates whether the requirements have been updated"
     value: ${{ steps.update-requirements.outputs.updated }}
 
 runs:
-  using: 'composite'
+  using: "composite"
   steps:
     - name: Update requirements
       id: update-requirements

.github/pull_request_template.md

@@ -17,6 +17,7 @@ Please reference any related feature requests, issues, or PRs here. For example,
 <!--
 If you're unsure about what to test, where to add tests, or how to run tests, please feel free to ask.
 -->
+
 - [ ] Existing unit/integration tests
 - [ ] New unit/integration tests
 - [ ] Manual tests (describe details, including test results, below)
@@ -40,7 +41,9 @@ Please describe how you confirmed the proposed feature/bug-fix/change works here
 (Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)
 
 ### What component(s), interfaces, languages, and integrations does this PR affect?
+
 Components
+
 - [ ] `area/artifacts`: Artifact stores and artifact logging
 - [ ] `area/build`: Build and test infrastructure for MLflow
 - [ ] `area/docs`: MLflow documentation pages
@@ -54,17 +57,20 @@ Components
 - [ ] `area/tracking`: Tracking Service, tracking client APIs, autologging
 
 Interface
+
 - [ ] `area/uiux`: Front-end, user experience, plotting, JavaScript, JavaScript dev server
 - [ ] `area/docker`: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
 - [ ] `area/sqlalchemy`: Use of SQLAlchemy in the Tracking Service or Model Registry
 - [ ] `area/windows`: Windows support
 
 Language
+
 - [ ] `language/r`: R APIs and clients
 - [ ] `language/java`: Java APIs and clients
 - [ ] `language/new`: Proposals for new client languages
 
 Integrations
+
 - [ ] `integrations/azure`: Azure and Azure ML integrations
 - [ ] `integrations/sagemaker`: SageMaker integrations
 - [ ] `integrations/databricks`: Databricks integrations
@@ -74,7 +80,9 @@ Insert an empty named anchor here to allow jumping to this section with a fragme
 (e.g. https://github.com/mlflow/mlflow/pull/123#user-content-release-note-category).
 Note that GitHub prefixes anchor names in markdown with "user-content-".
 -->
+
 <a name="release-note-category"></a>
+
 ### How should the PR be classified in the release notes? Choose one:
 
 - [ ] `rn/breaking-change` - The PR will be mentioned in the "Breaking Changes" section

.github/stale.yml

@@ -39,8 +39,8 @@ markComment: >
 
 # Comment to post when closing a stale Issue or Pull Request.
 closeComment: >
-   This issue has not been interacted with for 365 days since it was marked as stale! As such, the
-   issue is now closed. If you have this issue or more information, please re-open the issue!
+  This issue has not been interacted with for 365 days since it was marked as stale! As such, the
+  issue is now closed. If you have this issue or more information, please re-open the issue!
 
 # Limit the number of actions per hour, from 1-30. Default is 30
 limitPerRun: 30

.github/workflows/autoformat.js

@@ -26,10 +26,7 @@ const getPullInformation = async (context, github) => {
     ref: head_ref,
     repo: { full_name },
   } = pr.data.head;
-  const {
-    sha: base_sha,
-    ref: base_ref,
-  } = pr.data.base;
+  const { sha: base_sha, ref: base_ref } = pr.data.base;
   return {
     repository: full_name,
     pull_number,
@@ -47,26 +44,26 @@ const createReaction = async (context, github) => {
     owner,
     repo,
     comment_id,
-    content: 'rocket',
+    content: "rocket",
   });
 };
 
 const createStatus = async (context, github, core) => {
   const { head_sha, head_ref, repository } = await getPullInformation(context, github);
-  if (repository === 'mlflow/mlflow' && head_ref === 'master') {
-    core.setFailed('Running autoformat bot against master branch of mlflow/mlflow is not allowed.');
+  if (repository === "mlflow/mlflow" && head_ref === "master") {
+    core.setFailed("Running autoformat bot against master branch of mlflow/mlflow is not allowed.");
   }
-  await createCommitStatus(context, github, head_sha, 'pending');
+  await createCommitStatus(context, github, head_sha, "pending");
 };
 
 const updateStatus = async (context, github, sha, needs) => {
-  const failed = Object.values(needs).some(({ result }) => result === 'failure');
-  const state = failed ? 'failure' : 'success';
+  const failed = Object.values(needs).some(({ result }) => result === "failure");
+  const state = failed ? "failure" : "success";
   await createCommitStatus(context, github, sha, state);
 };
 
 const isMlflowMaintainer = (commentAuthorAssociation) => {
-  return ['OWNER', 'MEMBER', 'COLLABORATOR'].includes(commentAuthorAssociation);
+  return ["OWNER", "MEMBER", "COLLABORATOR"].includes(commentAuthorAssociation);
 };
 
 module.exports = {

.github/workflows/autoformat.yml

@@ -80,6 +80,11 @@ jobs:
           git fetch origin ${{ needs.check-comment.outputs.base_ref }}
           git merge origin/${{ needs.check-comment.outputs.base_ref }}
       # ************************************************************************
+      # Prettier
+      # ************************************************************************
+      - run: |
+          pre-commit run prettier --all-files --color=always || true
+      # ************************************************************************
       # protos
       # ************************************************************************
       - if: steps.diff.outputs.protos == 'true'

.github/workflows/closing-pr.js

@@ -4,12 +4,12 @@ const CLOSING_SYNTAX_PATTERNS = [
   /(?:(?:close|fixe|resolve)[sd]?|fix)\s+(?:mlflow\/mlflow)?#(\d+)/gi,
   /(?:(?:close|fixe|resolve)[sd]?|fix)\s+(?:https?:\/\/github.com\/mlflow\/mlflow\/issues\/)(\d+)/gi,
 ];
-const HAS_CLOSING_PR_LABEL = 'has-closing-pr';
+const HAS_CLOSING_PR_LABEL = "has-closing-pr";
 
 const getIssuesToClose = (body) => {
-  const commentsExcluded = body.replace(/<!--(.+?)-->/gs, ''); // remove comments
+  const commentsExcluded = body.replace(/<!--(.+?)-->/gs, ""); // remove comments
   const matches = CLOSING_SYNTAX_PATTERNS.flatMap((pattern) =>
-    Array.from(commentsExcluded.matchAll(pattern)),
+    Array.from(commentsExcluded.matchAll(pattern))
   );
   const issueNumbers = matches.map((match) => match[1]);
   return [...new Set(issueNumbers)].sort();
@@ -30,32 +30,32 @@ const capitalizeFirstLetter = (string) => {
 };
 
 const test = () => {
-  ['close', 'closes', 'closed', 'fix', 'fixes', 'fixed', 'resolve', 'resolves', 'resolved'].forEach(
+  ["close", "closes", "closed", "fix", "fixes", "fixed", "resolve", "resolves", "resolved"].forEach(
     (keyword) => {
-      assertArrayEqual(getIssuesToClose(`${keyword} #123`), ['123']);
-      assertArrayEqual(getIssuesToClose(`${capitalizeFirstLetter(keyword)} #123`), ['123']);
-    },
+      assertArrayEqual(getIssuesToClose(`${keyword} #123`), ["123"]);
+      assertArrayEqual(getIssuesToClose(`${capitalizeFirstLetter(keyword)} #123`), ["123"]);
+    }
   );
 
   const body2 = `
 Fix mlflow/mlflow#123
 Resolve https://github.com/mlflow/mlflow/issues/456
 `;
-  assertArrayEqual(getIssuesToClose(body2), ['123', '456']);
+  assertArrayEqual(getIssuesToClose(body2), ["123", "456"]);
 
   const body3 = `
 Fix #123
 Close #123
 `;
-  assertArrayEqual(getIssuesToClose(body3), ['123']);
+  assertArrayEqual(getIssuesToClose(body3), ["123"]);
 
-  const body4 = 'Relates to #123';
+  const body4 = "Relates to #123";
   assertArrayEqual(getIssuesToClose(body4), []);
 
-  const body5 = '<!-- close #123 -->';
+  const body5 = "<!-- close #123 -->";
   assertArrayEqual(getIssuesToClose(body5), []);
 
-  const body6 = 'Fixs #123 Fixd #456';
+  const body6 = "Fixs #123 Fixd #456";
   assertArrayEqual(getIssuesToClose(body6), []);
 };
 
@@ -66,7 +66,7 @@ if (require.main === module) {
 
 module.exports = async ({ context, github }) => {
   const { body } = context.payload.pull_request;
-  getIssuesToClose(body || '').forEach(async (issue_number) => {
+  getIssuesToClose(body || "").forEach(async (issue_number) => {
     const { owner, repo } = context.repo;
     await github.rest.issues.addLabels({
       owner,

.github/workflows/dev-setup.yml

@@ -3,9 +3,9 @@ name: Dev environment setup
 on:
   push:
     paths:
-      - 'dev/dev-env-setup.sh'
-      - 'dev/test-dev-env-setup.sh'
-      - '.github/workflows/dev-setup.yml'
+      - "dev/dev-env-setup.sh"
+      - "dev/test-dev-env-setup.sh"
+      - ".github/workflows/dev-setup.yml"
   schedule:
     - cron: "42 7 * * 0"
   workflow_dispatch: