Use single quotes, improve general configuration, improve ci."

Author: viferga

.eslintignore

@@ -1,4 +1,4 @@
 node_modules
 .docusaurus
 build
-public
+static

.eslintrc.js

@@ -2,42 +2,47 @@
 module.exports = {
   root: true,
   extends: [
-    "plugin:@docusaurus/recommended",
-    "plugin:mdx/recommended",
-    "plugin:import/recommended",
+    'plugin:@docusaurus/recommended',
+    'plugin:mdx/recommended',
+    'plugin:import/recommended',
   ],
-  plugins: ["@docusaurus", "mdx", "import"],
+  plugins: ['@docusaurus', 'mdx', 'import'],
   parserOptions: {
     ecmaVersion: 2021,
-    sourceType: "module",
+    sourceType: 'module',
     ecmaFeatures: {
       jsx: true,
     },
   },
 
   settings: {
     react: {
-      version: "detect",
+      version: 'detect',
     },
     // Fix for import resolution if you keep getting import errors
-    "import/resolver": {
+    'import/resolver': {
       node: {
-        extensions: [".js", ".jsx", ".ts", ".tsx"],
+        extensions: ['.js', '.jsx', '.ts', '.tsx'],
       },
     },
   },
   rules: {
-    "@docusaurus/no-untranslated-text": "off",
-    "@docusaurus/string-literal-i18n-messages": "error",
+    '@docusaurus/no-untranslated-text': 'off',
+    '@docusaurus/string-literal-i18n-messages': 'error',
 
     // Suggest using Docusaurus headings, but don't error out
-    "@docusaurus/prefer-docusaurus-heading": "warn",
+    '@docusaurus/prefer-docusaurus-heading': 'warn',
 
     // Import rules
-    "import/no-unresolved": [
-      "error",
-      { ignore: ["^@theme", "^@docusaurus", "^@site"] },
+    'import/no-unresolved': [
+      'error',
+      { ignore: ['^@theme', '^@docusaurus', '^@site'] },
+    ],
+    'import/no-named-as-default': 'off',
+    quotes: [
+      'error',
+      'single',
+      { avoidEscape: true, allowTemplateLiterals: true },
     ],
-    "import/no-named-as-default": "off",
   },
 };

.github/workflows/deploy.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [master]
   pull_request:
-    types: [ opened, synchronize, reopened, closed ]
+    types: [opened, synchronize, reopened, closed]
 
 permissions:
   contents: write
@@ -13,62 +13,8 @@ permissions:
   pull-requests: write
 
 jobs:
-
-  format-check:
-    name: Prettier Check
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 22
-
-      - name: Cache npm dependencies
-        uses: actions/cache@v4
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Install dependencies
-        run: npm ci --prefer-offline
-
-      - name: Check Formatting (Prettier)
-        run: npm run format:check
-
-  lint-check:
-    name: ESLint Check
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 22
-
-      - name: Cache npm dependencies
-        uses: actions/cache@v4
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Install dependencies
-        run: npm ci --prefer-offline
-
-      - name: Lint Code (ESLint)
-        run: npm run lint
-
-
-
   build:
     name: Build Site
-    needs: [ format-check, lint-check ]
     if: github.event.action != 'closed'
     runs-on: ubuntu-latest
 
@@ -94,6 +40,12 @@ jobs:
       - name: Install dependencies
         run: npm ci --prefer-offline
 
+      - name: Lint Code (ESLint)
+        run: npm run lint
+
+      - name: Check Formatting (Prettier)
+        run: npm run format
+
       - name: Inject correct baseUrl into docusaurus.config.js
         id: inject
         run: |
@@ -117,8 +69,6 @@ jobs:
           name: docusaurus-build
           path: build
 
-
-  
   deploy:
     name: Deploy Preview
     needs: build
@@ -161,7 +111,6 @@ jobs:
             🚀 **Preview Deployed**
             🔗 [View Preview](${{ steps.vars.outputs.url }})
 
-
   cleanup:
     name: Cleanup Preview
     if: github.event_name == 'pull_request' && github.event.action == 'closed'

docs/tutorials/treetraversal.mdx

@@ -1,4 +1,4 @@
-import DocusaurusTreeVisualization from "@site/src/components/TreeTraversal/DocusaurusWrapper";
+import DocusaurusTreeVisualization from '@site/src/components/TreeTraversal/DocusaurusWrapper';
 
 # Traversing a Polyglot Tree with MetaCall
 import StarRepo from '@site/src/components/StarRepo';

docusaurus.config.js

@@ -4,44 +4,44 @@
 // There are various equivalent ways to declare your Docusaurus config.
 // See: https://docusaurus.io/docs/api/docusaurus-config
 
-import { themes as prismThemes } from "prism-react-renderer";
+import { themes as prismThemes } from 'prism-react-renderer';
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
-  title: "MetaCall Docs",
-  tagline: "Documentation for MetaCall",
-  favicon: "img/metacall-logo.png",
+  title: 'MetaCall Docs',
+  tagline: 'Documentation for MetaCall',
+  favicon: 'img/metacall-logo.png',
 
   // Set the production url of your site here
-  url: "https://github.com",
+  url: 'https://github.com',
   // Set the /<baseUrl>/ pathname under which your site is served
-  baseUrl: "/doc/",
+  baseUrl: '/doc/',
 
   // GitHub pages deployment config.
-  organizationName: "metacall", // your GitHub user/org
-  projectName: "doc", // repo name
-  deploymentBranch: "gh-pages",
+  organizationName: 'metacall', // your GitHub user/org
+  projectName: 'doc', // repo name
+  deploymentBranch: 'gh-pages',
 
-  onBrokenLinks: "warn",
-  onBrokenMarkdownLinks: "warn",
+  onBrokenLinks: 'warn',
+  onBrokenMarkdownLinks: 'warn',
 
   i18n: {
-    defaultLocale: "en",
-    locales: ["en"],
+    defaultLocale: 'en',
+    locales: ['en'],
   },
 
   presets: [
     [
-      "classic",
+      'classic',
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
-          sidebarPath: "./sidebars.js",
-          tagsBasePath: "tags",
+          sidebarPath: './sidebars.js',
+          tagsBasePath: 'tags',
           breadcrumbs: true,
         },
         theme: {
-          customCss: "./src/css/custom.css",
+          customCss: './src/css/custom.css',
         },
       }),
     ],
@@ -50,86 +50,86 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
-      customCss: "./src/css/custom.css",
-      image: "img/docusaurus-social-card.jpg",
+      customCss: './src/css/custom.css',
+      image: 'img/docusaurus-social-card.jpg',
       navbar: {
-        title: "Metacall Docs",
+        title: 'Metacall Docs',
         logo: {
-          alt: "My Site Logo",
-          src: "img/metacall-logo.png",
+          alt: 'My Site Logo',
+          src: 'img/metacall-logo.png',
         },
         items: [
           {
-            type: "docSidebar",
-            sidebarId: "tutorialSidebar",
-            position: "left",
-            label: "Documentation",
+            type: 'docSidebar',
+            sidebarId: 'tutorialSidebar',
+            position: 'left',
+            label: 'Documentation',
           },
           // Use "to" for internal Docusaurus routes
           {
-            label: "Install",
-            to: "/docs/category/installating-metacall-cli",
-            position: "left",
+            label: 'Install',
+            to: '/docs/category/installating-metacall-cli',
+            position: 'left',
           },
           {
-            label: "Tutorials",
-            to: "/docs/category/tutorials",
-            position: "left",
+            label: 'Tutorials',
+            to: '/docs/category/tutorials',
+            position: 'left',
           },
           {
-            href: "/starred",
-            label: "⭐ Stars",
-            position: "right",
+            href: '/starred',
+            label: '⭐ Stars',
+            position: 'right',
           },
           {
-            href: "https://github.com/metacall",
-            label: "GitHub",
-            position: "right",
+            href: 'https://github.com/metacall',
+            label: 'GitHub',
+            position: 'right',
           },
         ],
       },
 
       footer: {
-        style: "dark",
+        style: 'dark',
         links: [
           {
-            title: "Intro",
+            title: 'Intro',
             items: [
-              { label: "Getting Started", to: "/docs/getting-started" },
+              { label: 'Getting Started', to: '/docs/getting-started' },
               {
-                label: "Install",
-                to: "/docs/category/installating-metacall-cli",
+                label: 'Install',
+                to: '/docs/category/installating-metacall-cli',
               },
             ],
           },
           {
-            title: "Use MetaCall",
+            title: 'Use MetaCall',
             items: [
-              { label: "Tutorials", to: "/docs/category/tutorials" },
-              { label: "Deployment", to: "/docs/deployment" },
+              { label: 'Tutorials', to: '/docs/category/tutorials' },
+              { label: 'Deployment', to: '/docs/deployment' },
             ],
           },
           {
-            title: "Community",
+            title: 'Community',
             items: [
-              { label: "Discord", href: "https://discord.gg/upwP4mwJWa" },
+              { label: 'Discord', href: 'https://discord.gg/upwP4mwJWa' },
               {
-                label: "Telegram",
-                href: "https://t.me/joinchat/BMSVbBatp0Vi4s5l4VgUgg",
+                label: 'Telegram',
+                href: 'https://t.me/joinchat/BMSVbBatp0Vi4s5l4VgUgg',
               },
               {
-                label: "Matrix",
-                href: "https://matrix.to/#/#metacall:matrix.org",
+                label: 'Matrix',
+                href: 'https://matrix.to/#/#metacall:matrix.org',
               },
             ],
           },
           {
-            title: "More",
+            title: 'More',
             items: [
-              { label: "GitHub", href: "https://github.com/metacall/" },
+              { label: 'GitHub', href: 'https://github.com/metacall/' },
               {
-                label: "Changelog",
-                href: "https://github.com/metacall/core/releases",
+                label: 'Changelog',
+                href: 'https://github.com/metacall/core/releases',
               },
             ],
           },

package.json

@@ -1,7 +1,6 @@
 {
-  "name": "metacall-tutorial",
-  "version": "0.0.0",
-  "private": true,
+  "name": "metacall-doc",
+  "version": "0.0.1",
   "scripts": {
     "docusaurus": "docusaurus",
     "dev": "docusaurus dev",
@@ -15,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids",
     "lint": "eslint . --ext .js,.jsx,.ts,.tsx,.mdx",
     "lint:fix": "eslint . --ext .js,.jsx,.ts,.tsx,.mdx --fix",
-    "format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,md,mdx}\"",
-    "format:check": "prettier --check \"src/**/*.{js,jsx,ts,tsx,json,md,mdx}\"",
+    "format": "prettier --check \"src/**/*.{js,jsx,ts,tsx,json,md,mdx}\"",
+    "format:fix": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,md,mdx}\"",
     "prepare": "husky"
   },
   "dependencies": {
@@ -70,6 +69,6 @@
     ]
   },
   "engines": {
-    "node": ">=18.0"
+    "node": ">=20.0"
   }
-}
+}