Merge branch 'nushell:main' into main

Author: cablehead

.github/workflows/command-block.yml

@@ -1,12 +1,16 @@
 name: Comment on manual command changes
 on:
-  pull_request:
+  pull_request_target:
     paths:
       - 'commands/docs/**'
+      - 'commands/categories/**'
 
 jobs:
   comment:
     runs-on: ubuntu-latest
+    # Maintainers/Contributors can add themselves exempt from this bot if they regularly run the command doc generation.
+    # If you are on this list, be careful about accidental changes!
+    if: ${{!contains(fromJSON('["hustcer", "sholderbach"]'), github.event.pull_request.user.login)}}
     steps:
       - uses: actions/[email protected]
         with:
@@ -16,8 +20,13 @@ jobs:
               owner: context.repo.owner,
               repo: context.repo.repo,
               body: 'Awesome that you are trying to improve the documentation of a nushell command!\n\n' +
-                'As we autogenerate these command pages from the help information defined with the command after each release:\n'+
-                '- If you already updated the command help, you are already done!\n'+
-                '- Else, please look for the command in the [source tree](https://github.com/nushell/nushell/tree/main/crates) and make your changes directly there.\n\n'+
+                '**You should not modify the files in `commands/docs` or `commands/categories`!**\n' +
+                'We autogenerate these command pages from the `help` information defined by the command implementation, after each release. Thus:\n'+
+                '- If you already updated the command help, you are already done and can close this PR!\n'+
+                '- Else, please look for the command in the [source tree](https://github.com/nushell/nushell/tree/main/crates) and make your changes directly there in the `impl Command` and `Signature`.\n'+
+                '- If you accidentally made a change in `commands/` while working on general documentation, please revert changes to `commands/`\n\n'+
                 'Thanks for helping out!'
             })
+      - run: |
+          echo "This PR touched autogenerated command docs. If you are not a maintainer of the autogenerated docs, please revert changes to `commands/docs/**` and make the change on the nushell side"
+          exit 1

.vuepress/components/BlogPosts.vue

@@ -29,7 +29,10 @@ export default {
           let path = p.path.replace('/blog/', '');
           return { ...p, path: path, date: path.substring(0, 10) };
         })
-        .sort((a, b) => new Date(b.date) - new Date(a.date));
+        .sort(
+          (a, b) =>
+            new Date(b.date) - new Date(a.date) || b.path.localeCompare(a.path),
+        );
     },
   },
 };

.vuepress/config.js

@@ -20,6 +20,7 @@ import {
   navbarPtBR,
   navbarRU,
   navbarZhCN,
+  navbarKo,
   sidebarDe,
   sidebarEn,
   sidebarFr,
@@ -28,6 +29,7 @@ import {
   sidebarPtBR,
   sidebarRU,
   sidebarZhCN,
+  sidebarKo,
 } from './configs/index.js';
 
 const compareDate = (dateA, dateB) => {
@@ -88,8 +90,23 @@ export default defineUserConfig({
       title: 'Nushell',
       description: 'Новый тип оболочки.',
     },
+    '/ko/': {
+      lang: 'ko-KR',
+      title: 'Nushell',
+      description: '새로운 유형의 셸',
+    },
   },
   head: [
+    [
+      'link',
+      {
+        rel: 'preload',
+        href: '/fonts/FiraCode-Regular.woff2',
+        as: 'font',
+        type: 'font/woff2',
+        crossorigin: 'anonymous',
+      },
+    ],
     ['meta', { name: 'theme-color', content: '#3eaf7c' }],
     ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
     [
@@ -103,11 +120,15 @@ export default defineUserConfig({
       handleImportPath: (str) =>
         str.replace(/^@snippets/, path.resolve(__dirname, '../snippets')),
     },
+    highlighter: 'shiki',
   },
   // without this, we attempt to prefetch the whole site 😬
   shouldPrefetch: false,
   colorMode: 'auto',
   theme: defaultTheme({
+    markdown: {
+      highlighter: 'shiki',
+    },
     repo: 'nushell/nushell',
     repoLabel: 'GitHub',
     editLinks: true,
@@ -171,6 +192,16 @@ export default defineUserConfig({
         navbar: navbarZhCN,
         sidebar: sidebarZhCN,
       },
+      '/ko/': {
+        selectText: '언어',
+        selectLanguageName: '한국어',
+        editLinkText: 'GitHub에서 수정하기',
+        navbar: navbarKo,
+        sidebar: sidebarKo,
+      },
+    },
+    themePlugins: {
+      prismjs: false,
     },
   }),
   plugins: [
@@ -185,14 +216,40 @@ export default defineUserConfig({
       },
     }),
     shikiPlugin({
-      theme: 'dark-plus',
-      lineNumbers: true,
+      themes: {
+        light: 'dark-plus',
+        dark: 'dark-plus',
+        onedarkpro: 'one-dark-pro', // pre-load one-dark-pro for ansi code blocks
+      },
+      lineNumbers: 10,
+      collapsedLines: false,
+      transformers: [
+        // use one-dark-pro theme for ansi code blocks
+        {
+          preprocess(code, options) {
+            if (options.lang == 'ansi') {
+              this.options.defaultColor = 'onedarkpro';
+              // this doesn't work at the top-level for some reason
+              this.options.colorReplacements = {
+                // make one-dark-pro background color the same as dark-plus
+                '#282c34': '#1e1e1e',
+                // HACK: change color of comments, since nu-highlight can't highlight them
+                '#abb2bf': '#80858f',
+              };
+            }
+            return code;
+          },
+        },
+      ],
       langs: [
+        'csv',
         'nushell',
         'rust',
         'bash',
         'shell',
         'sh',
+        'csv',
+        'ansi',
         'toml',
         'json',
         'javascript',
@@ -218,14 +275,27 @@ export default defineUserConfig({
         );
       },
       sorter: (a, b) => {
-        return compareDate(
-          a.data.git?.createdTime
-            ? new Date(a.data.git?.createdTime)
-            : a.frontmatter.date,
-          b.data.git?.createdTime
-            ? new Date(b.data.git?.createdTime)
-            : b.frontmatter.date,
+        const pathDateA = new Date(
+          a.path.replace('/blog/', '').substring(0, 10),
+        );
+        const pathDateB = new Date(
+          b.path.replace('/blog/', '').substring(0, 10),
         );
+        const effectiveDateA =
+          pathDateA != 'Invalid Date'
+            ? pathDateA
+            : a.frontmatter.date
+              ? new Date(a.frontmatter.date)
+              : new Date(a.data.git?.createdTime);
+
+        // Determine the effective date for item B
+        const effectiveDateB =
+          pathDateB != 'Invalid Date'
+            ? pathDateB
+            : b.frontmatter.date
+              ? new Date(b.frontmatter.date)
+              : new Date(b.data.git?.createdTime);
+        return compareDate(effectiveDateA, effectiveDateB);
       },
     }),
     sitemapPlugin({

.vuepress/configs/navbar/index.ts

@@ -6,3 +6,4 @@ export * from './ja.js';
 export * from './pt-BR.js';
 export * from './ru.js';
 export * from './zh-CN.js';
+export * from './ko.js';

.vuepress/configs/navbar/ko.ts

@@ -0,0 +1,8 @@
+import type { NavbarConfig } from '@vuepress/theme-default';
+
+export const navbarKo: NavbarConfig = [
+  { text: '문서', link: '/ko/book/' },
+  // { text: "Contributor Book", link: "/contributor-book/" },
+  { text: '쿡북', link: '/cookbook/' },
+  { text: '블로그', link: '/blog/' },
+];

.vuepress/configs/navbar/zh-CN.ts

@@ -1,8 +1,17 @@
 import type { NavbarConfig } from '@vuepress/theme-default';
 
 export const navbarZhCN: NavbarConfig = [
-  { text: '书', link: '/zh-CN/book/' },
-  // { text: "Contributor Book", link: "/contributor-book/" },
-  { text: 'Cookbook', link: '/cookbook/' },
+  { text: '安装 Nu !', link: '/zh-CN/book/installation' },
+  { text: '快速开始', link: '/zh-CN/book/getting_started' },
+  {
+    text: '文档',
+    children: [
+      { text: 'Nushell 之书', link: '/zh-CN/book/' },
+      { text: '命令参考列表', link: '/commands/' },
+      { text: '实战指南', link: '/zh-CN/cookbook/' },
+      { text: '语言参考指南', link: '/lang-guide/' },
+      { text: '贡献指南', link: '/zh-CN/contributor-book/' },
+    ],
+  },
   { text: '博客', link: '/blog/' },
 ];

.vuepress/configs/sidebar/command_categories.ts

@@ -11,6 +11,7 @@ export const commandCategories = [
   '/commands/categories/debug.md',
   '/commands/categories/default.md',
   '/commands/categories/env.md',
+  '/commands/categories/experimental.md',
   '/commands/categories/expression.md',
   '/commands/categories/filesystem.md',
   '/commands/categories/filters.md',

.vuepress/configs/sidebar/de.ts

@@ -57,7 +57,7 @@ export const sidebarDe: SidebarConfig = {
         '/de/book/custom_completions',
         '/de/book/coloring_and_theming',
         '/de/book/hooks',
-        '/de/book/background_task.md',
+        '/de/book/background_jobs.md',
       ],
     },
     {

.vuepress/configs/sidebar/en.ts

@@ -38,6 +38,7 @@ export const sidebarEn: SidebarConfig = {
         '/book/working_with_records.md',
         '/book/working_with_tables.md',
         '/book/navigating_structured_data.md',
+        '/book/special_variables.md',
       ],
     },
     {
@@ -61,6 +62,7 @@ export const sidebarEn: SidebarConfig = {
           ],
         },
         '/book/overlays.md',
+        '/book/sorting.md',
         '/book/testing.md',
         '/book/style_guide.md',
       ],
@@ -73,15 +75,15 @@ export const sidebarEn: SidebarConfig = {
         '/book/configuration.md',
         '/book/environment.md',
         '/book/stdout_stderr_exit_codes.md',
-        '/book/escaping.md',
+        '/book/running_externals.md',
         '/book/3rdpartyprompts.md',
-        '/book/shells_in_shells.md',
+        '/book/directory_stack.md',
         '/book/line_editor.md',
         '/book/custom_completions.md',
         '/book/externs.md',
         '/book/coloring_and_theming.md',
         '/book/hooks.md',
-        '/book/background_task.md',
+        '/book/background_jobs.md',
       ],
     },
     {
@@ -152,6 +154,7 @@ export const sidebarEn: SidebarConfig = {
         '/cookbook/parsing',
         '/cookbook/foreign_shell_scripts',
         '/cookbook/pattern_matching',
+        '/cookbook/custom_completers',
         '/cookbook/external_completers',
         '/cookbook/modules',
         '/cookbook/files',

.vuepress/configs/sidebar/index.ts

@@ -6,3 +6,4 @@ export * from './ja.js';
 export * from './pt-BR.js';
 export * from './ru.js';
 export * from './zh-CN.js';
+export * from './ko.js';