Merge pull request #107 from sdkman/refactoring

Refactoring

Author: SvMak

.prettierrc

@@ -1,4 +1,18 @@
 {
   "singleQuote": true,
-  "proseWrap": "always"
+  "proseWrap": "always",
+  "plugins": ["@trivago/prettier-plugin-sort-imports"],
+  "importOrder": [
+    "^@site/src/types/(.*)$",
+    "^react(/[^\\/]+)?$",
+    "<THIRD_PARTY_MODULES>",
+    "^@site/src/components/(.*)$",
+    "^@site/src/hooks/(.*)$",
+    "^@site/src/lib/(.*)$",
+    "^@site/src/data/(.*)$",
+    "^@site/src/(.*)$",
+    "^[./]"
+  ],
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true
 }

docs/install.mdx

@@ -2,7 +2,7 @@
 title: Installation
 ---
 
-import DocsCarbonAds from '@site/src/components/sections/DocsCarbonAds';
+import DocsCarbonAds from '@site/src/components/ads/DocsCarbonAds';
 
 <DocsCarbonAds />
 
@@ -107,17 +107,19 @@ curl -s "https://get.sdkman.io?rcupdate=false" | bash
 
 ## CI Mode
 
-For automated environments like CI/CD pipelines, SDKMAN! offers a dedicated CI mode
-that optimizes the installation for non-interactive use:
+For automated environments like CI/CD pipelines, SDKMAN! offers a dedicated CI
+mode that optimizes the installation for non-interactive use:
 
 ```shell
 curl -s "https://get.sdkman.io?ci=true" | bash
 ```
 
 CI mode automatically:
+
 - Answers all prompts (sets `sdkman_auto_answer=true`)
 - Disables colored output for cleaner logs (sets `sdkman_colour_enable=false`)
-- Turns off the self-update feature to prevent unexpected updates (sets `sdkman_selfupdate_feature=false`)
+- Turns off the self-update feature to prevent unexpected updates (sets
+  `sdkman_selfupdate_feature=false`)
 
 You can combine this with other parameters as needed:
 

docs/usage.mdx

@@ -2,7 +2,7 @@
 title: Usage
 ---
 
-import DocsCarbonAds from '@site/src/components/sections/DocsCarbonAds';
+import DocsCarbonAds from '@site/src/components/ads/DocsCarbonAds';
 
 <DocsCarbonAds />
 
@@ -305,7 +305,7 @@ native: 0.1.3
 ## Offline Mode
 
 Initially called _Aeroplane Mode_, this allows SDKMAN! to function when working
-offline. It has a parameter that can be passed to *enable* or _disable_ the
+offline. It has a parameter that can be passed to _enable_ or _disable_ the
 offline mode.
 
 ```shell

docs/vendors.mdx

@@ -2,7 +2,7 @@
 title: Vendors
 ---
 
-import DocsCarbonAds from '@site/src/components/sections/DocsCarbonAds';
+import DocsCarbonAds from '@site/src/components/ads/DocsCarbonAds';
 
 <DocsCarbonAds />
 
@@ -130,11 +130,14 @@ https://vendors.sdkman.io/default
 
 ## GitHub Actions
 
-If you're using GitHub Actions for your CI/CD pipeline, SDKMAN! provides official GitHub Actions that can help you automate the release process.
+If you're using GitHub Actions for your CI/CD pipeline, SDKMAN! provides
+official GitHub Actions that can help you automate the release process.
 
 ### SDKMAN! Release Action
 
-The [SDKMAN! Release Action](https://github.com/sdkman/sdkman-release-action) allows you to release a new version of your candidate to SDKMAN! directly from your GitHub workflow.
+The [SDKMAN! Release Action](https://github.com/sdkman/sdkman-release-action)
+allows you to release a new version of your candidate to SDKMAN! directly from
+your GitHub workflow.
 
 #### Features
 
@@ -163,7 +166,10 @@ jobs:
           consumer_token: ${{ secrets.SDKMAN_CONSUMER_TOKEN }}
           candidate: myCandidateName
           version: ${{ github.event.release.tag_name }}
-          url: https://github.com/myorg/myrepo/releases/download/${{ github.event.release.tag_name }}/mycandidatename-${{ github.event.release.tag_name }}.zip
+          url:
+            https://github.com/myorg/myrepo/releases/download/${{
+            github.event.release.tag_name }}/mycandidatename-${{
+            github.event.release.tag_name }}.zip
 ```
 
 #### Advanced Usage
@@ -191,10 +197,12 @@ jobs:
           consumer-token: ${{ secrets.SDKMAN_CONSUMER_TOKEN }}
           candidate: java
           version: ${{ github.event.inputs.version }}
-          url: https://github.com/acme/java/releases/download/${{ github.event.inputs.version }}/java-linux-x64.tar.gz
+          url:
+            https://github.com/acme/java/releases/download/${{
+            github.event.inputs.version }}/java-linux-x64.tar.gz
           platform: LINUX_64
-          checksum-md5: "abcd1234..."
-          checksum-sha-512: "efgh5678..."
+          checksum-md5: 'abcd1234...'
+          checksum-sha-512: 'efgh5678...'
 ```
 
 ## Gradle SDK Vendor Plugin

package-lock.json

@@ -36,6 +36,7 @@
     "@docusaurus/module-type-aliases": "^3.8.1",
     "@docusaurus/tsconfig": "^3.8.1",
     "@docusaurus/types": "^3.8.1",
+    "@trivago/prettier-plugin-sort-imports": "^5.2.2",
     "prettier": "^3.6.0",
     "typescript": "~5.8.3"
   },

package.json

@@ -1,11 +1,11 @@
-import React, { useEffect, useRef } from 'react';
+import * as React from 'react';
 
 type Props = { code: string; placement: string };
 
 export default function CarbonAds({ code, placement }: Props) {
-  const ref = useRef<HTMLDivElement>(null);
+  const ref = React.useRef<HTMLDivElement>(null);
 
-  useEffect(() => {
+  React.useEffect(() => {
     if (ref.current) {
       ref.current.innerHTML = '';
       const s = document.createElement('script');

src/components/CarbonAds/index.tsx renamed to src/components/ads/CarbonAds/index.tsx

@@ -1,4 +1,5 @@
-import CarbonAds from '@site/src/components/CarbonAds';
+import CarbonAds from '@site/src/components/ads/CarbonAds';
+
 import { CARBON_ADS_CODE, CARBON_ADS_PLACEMENT } from '@site/src/constants';
 
 export default function DocsCarbonAds() {

src/components/sections/DocsCarbonAds/index.tsx renamed to src/components/ads/DocsCarbonAds/index.tsx

@@ -1,8 +1,9 @@
-import CarbonAds from '@site/src/components/CarbonAds';
-import styles from './styles.module.scss';
+import CarbonAds from '@site/src/components/ads/CarbonAds';
 
 import { CARBON_ADS_CODE, CARBON_ADS_PLACEMENT } from '@site/src/constants';
 
+import styles from './styles.module.scss';
+
 export default function PageCarbonAds() {
   return (
     <section className={styles.section}>