Merge pull request #136 from secundant/124-neodxvfs-redesign-api-and-…

…add-documentation

Rework `@neodx/vfs` from scratch

.changeset/brown-islands-juggle.md

@@ -0,0 +1,5 @@
+---
+'@neodx/glob': minor
+---
+
+Add `walkGlob`, low-level API for building glob-based search

.changeset/clean-gifts-destroy.md

@@ -0,0 +1,5 @@
+---
+'@neodx/vfs': minor
+---
+
+Stabilize `prettier` and `eslint` plugins

.changeset/config.json

@@ -7,13 +7,7 @@
   "access": "public",
   "baseBranch": "main",
   "updateInternalDependencies": "patch",
-  "ignore": [
-    "@neodx/scripts",
-    "@neodx/vite-plugin-library",
-    "@neodx/codegen",
-    "example-*",
-    "@neodx/docs"
-  ],
+  "ignore": ["@neodx/scripts", "@neodx/codegen", "example-*", "@neodx/docs"],
   "privatePackages": false,
   "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
     "updateInternalDependents": "always"

.changeset/eleven-poems-deliver.md

@@ -0,0 +1,5 @@
+---
+'@neodx/vfs': minor
+---
+
+Introduce renewed `@neodx/vfs` with new core, plugins, documentation and integrations

.changeset/green-radios-clean.md

@@ -0,0 +1,5 @@
+---
+'@neodx/log': minor
+---
+
+Preserve backend internals, fix readonly mode

.changeset/grumpy-flies-search.md

@@ -0,0 +1,12 @@
+---
+'@neodx/autobuild': patch
+'@neodx/pkg-misc': patch
+'@neodx/figma': patch
+'@neodx/log': patch
+'@neodx/std': patch
+'@neodx/svg': patch
+'@neodx/vfs': patch
+'@neodx/fs': patch
+---
+
+Upgrade dependencies

.changeset/odd-onions-sparkle.md

@@ -0,0 +1,5 @@
+---
+'@neodx/svg': minor
+---
+
+Make builder params more stable and simple

.changeset/pretty-ears-yell.md

@@ -0,0 +1,5 @@
+---
+'@neodx/vfs': minor
+---
+
+Add `scan` plugin

.changeset/real-ducks-notice.md

@@ -0,0 +1,5 @@
+---
+'@neodx/vfs': minor
+---
+
+Add `glob` plugin powered by `@neodx/glob` and `scan` plugin

.changeset/shiny-zebras-join.md

@@ -0,0 +1,5 @@
+---
+'@neodx/std': minor
+---
+
+Add `fromRange`, `mapEntries`, `mapToObject`, `tee` and other

.changeset/shy-pumpkins-grow.md

@@ -0,0 +1,5 @@
+---
+'@neodx/log': minor
+---
+
+Add "createLoggerAutoFactory" API

.changeset/slimy-turkeys-tickle.md

@@ -0,0 +1,5 @@
+---
+'@neodx/vfs': minor
+---
+
+Rework and simplify public API

.changeset/soft-wolves-smash.md

@@ -0,0 +1,5 @@
+---
+'@neodx/glob': minor
+---
+
+Add `extractGlobPaths` for a splitting single glob pattern to static paths and dynamic globs

.changeset/thirty-plants-count.md

@@ -0,0 +1,7 @@
+---
+'@neodx/autobuild': minor
+'@neodx/figma': minor
+'@neodx/svg': minor
+---
+
+Adapt new `@neodx/vfs`

.changeset/weak-cooks-fly.md

@@ -0,0 +1,5 @@
+---
+'@neodx/std': minor
+---
+
+Add `fromEntries`, `fromKeys`, and `zipObject` object helpers

.changeset/weak-meals-lay.md

@@ -0,0 +1,5 @@
+---
+'@neodx/glob': minor
+---
+
+Implement glob matching with `createGlobMatcher` and `matchGlob`

.github/workflows/ci.yaml

@@ -12,7 +12,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [18.x]
+        node-version: [20.x]
 
     steps:
       - uses: actions/checkout@v3
@@ -32,7 +32,6 @@ jobs:
       - name: Run NX checks
         run: |
           yarn nx format:check
-          yarn nx workspace-lint
           yarn nx affected --target lint --parallel 3
           yarn nx affected --target test --parallel 3
           yarn nx affected --target build --parallel 3

.github/workflows/release.yaml

@@ -20,7 +20,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: 18.x
+          node-version: 20.x
           cache: yarn
 
       - name: Install dependencies

.gitignore

@@ -66,3 +66,5 @@ node_modules
 .pnp.*
 
 # ========== Yarn ==========
+
+.nx/cache

.prettierignore

@@ -5,3 +5,6 @@
 .pnp.js
 .yarn/
 node_modules/
+**/.vitepress
+
+/.nx/cache

.yarnrc.yml

@@ -1,11 +1,4 @@
-changesetBaseRefs:
-  - main
-  - origin/main
-  - upstream/main
-
-changesetIgnorePatterns:
-  - '**/*.test.{js,ts,tsx}'
-  - '**/*.spec.{js,ts,tsx}'
+compressionLevel: mixed
 
 defaultSemverRangePrefix: ''
 
@@ -17,18 +10,4 @@ nodeLinker: node-modules
 
 npmRegistryServer: 'https://registry.npmjs.org/'
 
-plugins:
-  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
-    spec: '@yarnpkg/plugin-interactive-tools'
-  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
-    spec: '@yarnpkg/plugin-workspace-tools'
-  - path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
-    spec: '@yarnpkg/plugin-typescript'
-
-supportedArchitectures:
-  cpu:
-    - current
-  os:
-    - current
-
-yarnPath: .yarn/releases/yarn-3.2.0.cjs
+yarnPath: .yarn/releases/yarn-4.1.0.cjs

README.md

@@ -18,6 +18,7 @@ Packages overview:
 - [@neodx/figma](#neodxfigma) | [docs](https://neodx.pages.dev/figma) | [source](./libs/figma)
 - [@neodx/svg](#neodxsvg) | [docs](https://neodx.pages.dev/svg) | [source](./libs/svg)
 - [@neodx/log](#neodxlog) | [docs](https://neodx.pages.dev/log) | [source](./libs/log)
+- [@neodx/vfs](#neodxvfs) | [docs](https://neodx.pages.dev/vfs) | [source](./libs/vfs)
 
 ### [@neodx/figma](./libs/figma)
 
@@ -172,24 +173,14 @@ Meet `@neodx/vfs`, the missing abstraction layer for file system operations that
 ```typescript
 import { createVfs } from '@neodx/vfs';
 
-// main.ts
-const vfs = createVfs(process.cwd(), {
-  dryRun: process.env.DRY_RUN === 'true'
-});
+const fs = createVfs();
 
-await doSomethingWithVfs(vfs);
-await vfs.formatChangedFiles(); // Format all changed files
-await vfs.applyChanges(); // Only now changes will be applied to the real file system (if not in dry-run mode)!
-
-// other-file.ts
-async function doSomethingWithVfs(vfs: Vfs) {
-  await vfs.write('file.txt', 'Hello, world!');
-  // ...
-  await vfs.remove('other-file.txt');
-  await vfs.updateJson('manifest.json', manifest => {
-    manifest.version = '1.0.0';
-    return manifest;
-  });
+await fs.writeJson('.cache/meta.json', { timestamp: Date.now(), stats });
+await fs.updateJson('package.json', pkg => {
+  pkg.version = '1.0.0';
+});
+await fs.write('src/index.ts', 'export const foo = 42;');
+await fs.apply();
 }
 ```
 

apps/docs/.vitepress/config.ts

@@ -29,7 +29,9 @@ export default defineConfig({
         items: [
           { text: '@neodx/log', link: '/log/', activeMatch: '^/log/' },
           { text: '@neodx/svg', link: '/svg/', activeMatch: '^/svg/' },
-          { text: '@neodx/figma', link: '/figma/', activeMatch: '^/figma/' }
+          { text: '@neodx/figma', link: '/figma/', activeMatch: '^/figma/' },
+          { text: '@neodx/vfs', link: '/vfs/', activeMatch: '^/vfs/' },
+          { text: '@neodx/glob', link: '/glob/', activeMatch: '^/glob/' }
         ]
       }
     ],
@@ -201,6 +203,45 @@ export default defineConfig({
             ]
           }
         ]
+      },
+      {
+        text: '@neodx/vfs',
+        collapsed: true,
+        items: [
+          { text: 'Getting started', link: '/vfs/' },
+          { text: 'Extending', link: '/vfs/extending' },
+          {
+            text: 'Plugins',
+            items: [
+              { text: 'scan', link: '/vfs/plugins/scan' },
+              { text: 'glob', link: '/vfs/plugins/glob' },
+              { text: 'json', link: '/vfs/plugins/json' },
+              { text: 'eslint', link: '/vfs/plugins/eslint' },
+              { text: 'prettier', link: '/vfs/plugins/prettier' },
+              { text: 'package.json', link: '/vfs/plugins/package-json' }
+            ]
+          },
+          { text: 'Limitations', link: '/vfs/limitations' },
+          {
+            text: 'API',
+            collapsed: true,
+            items: [
+              { text: 'createVfs', link: '/vfs/api/create-vfs' },
+              { text: 'Plugins', link: '/vfs/api/plugins' },
+              { text: 'Context', link: '/vfs/api/context' },
+              { text: 'Backend', link: '/vfs/api/backend' }
+            ]
+          }
+        ]
+      },
+      {
+        text: '@neodx/glob',
+        collapsed: true,
+        items: [
+          { text: 'Getting started', link: '/glob/' },
+          { text: 'Writing your glob', link: '/glob/writing-your-glob' },
+          { text: 'API', link: '/glob/api' }
+        ]
       }
     ]
   }