vfs-kit 1.0.0 → 1.0.1

package/README.md

@@ -1,2 +1,35 @@
 # vfs-kit
 A headless-first Virtual File System for React. Complete with drag-and-drop hierarchy, tab management and pluggable storage adapters.
+
+## Building the library
+
+```bash
+npm install
+npm run build
+```
+
+The package is authored in TypeScript and exports ESM modules with declaration files. React, Tailwind, and any Shadcn UI components are declared as
+peer dependencies – a consuming project must provide them.
+
+## Using locally
+
+While developing you can link the package into a demo app:
+
+```bash
+cd ./*/vfs-kit-test
+npm link vfs-kit
+```
+
+Import components in your app:
+
+```tsx
+import { TreeView, useVfs } from "vfs-kit";
+```
+
+## Notes
+
+The current release only includes a simple placeholder component. Real
+Shadcn imports can be added once you’re ready; you may need to supply a
+local `declare module '@shadcn/ui';` or update tsconfig `moduleResolution` to
+`nodenext`.
+

package/dist/index.cjs

@@ -0,0 +1,43 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  TreeView: () => TreeView,
+  useVfs: () => useVfs
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/components/TreeView.tsx
+var import_react = require("react");
+var import_jsx_runtime = require("react/jsx-runtime");
+function TreeView() {
+  return /* @__PURE__ */ (0, import_jsx_runtime.jsx)("div", { children: "Placeholder TreeView" });
+}
+
+// src/hooks/useVfs.ts
+function useVfs() {
+  return {};
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  TreeView,
+  useVfs
+});

package/dist/index.d.cts

@@ -0,0 +1,7 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare function TreeView(): react_jsx_runtime.JSX.Element;
+
+declare function useVfs(): {};
+
+export { TreeView, useVfs };

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+declare function TreeView(): react_jsx_runtime.JSX.Element;
+
+declare function useVfs(): {};
+
+export { TreeView, useVfs };

package/dist/index.js

@@ -0,0 +1,15 @@
+// src/components/TreeView.tsx
+import "react";
+import { jsx } from "react/jsx-runtime";
+function TreeView() {
+  return /* @__PURE__ */ jsx("div", { children: "Placeholder TreeView" });
+}
+
+// src/hooks/useVfs.ts
+function useVfs() {
+  return {};
+}
+export {
+  TreeView,
+  useVfs
+};

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "vfs-kit",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A headless-first Virtual File System for React. Complete with drag-and-drop hierarchy, tab management and pluggable storage adapters.",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Benjamin Gruber"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bengru07/vfs-kit.git"
+    "url": "git+https://github.com/bengru07/vfs-kit.git",
+    "directory": "packages/cli"
   },
   "keywords": [
     "react",
@@ -28,10 +32,41 @@
     "virtual-fs",
     "history"
   ],
-  "author": "Benjamin Gruber",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/bengru07/vfs-kit/issues"
+  "type": "module",
+  "exports": "./dist/index.js",
+  "bin": {
+    "@vfs-kit": "./dist/index.js"
+  },
+  "dependencies": {
+    "chalk": "5.2.0",
+    "commander": "^10.0.0",
+    "execa": "^7.0.0",
+    "fs-extra": "^11.1.0",
+    "node-fetch": "^3.3.0",
+    "ora": "^6.1.2",
+    "prompts": "^2.4.2",
+    "zod": "^3.20.2"
   },
-  "homepage": "https://github.com/bengru07/vfs-kit#readme"
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.1",
+    "@types/prompts": "^2.4.2",
+    "rimraf": "^4.1.3",
+    "tsup": "^6.6.3",
+    "type-fest": "^3.6.1",
+    "typescript": "^4.9.5"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist && rimraf components",
+    "start:dev": "cross-env COMPONENTS_BASE_URL=http://localhost:3000 node dist/index.js",
+    "start": "node dist/index.js",
+    "format:write": "prettier --write \"**/*.{ts,tsx,mdx}\" --cache",
+    "format:check": "prettier --check \"**/*.{ts,tsx,mdx}\" --cache",
+    "release": "changeset version",
+    "pub:beta": "pnpm build && pnpm publish --no-git-checks --access public --tag beta",
+    "pub:next": "pnpm build && pnpm publish --no-git-checks --access public --tag next",
+    "pub:release": "pnpm build && pnpm publish --access public"
+  }
 }

package/src/components/TreeView.tsx

@@ -0,0 +1,5 @@
+import React from "react";
+
+export function TreeView() {
+  return <div>Placeholder TreeView</div>;
+}

package/src/components/index.ts

@@ -0,0 +1 @@
+export * from "./TreeView.js";

package/src/hooks/index.ts

@@ -0,0 +1 @@
+export * from "./useVfs.js";

package/src/hooks/useVfs.ts

@@ -0,0 +1,3 @@
+export function useVfs() {
+  return {};
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from "./components/index.js";
+export * from "./hooks/index.js";

package/tsconfig.json

@@ -0,0 +1,44 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    // "rootDir": "./src",
+    // "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+  }
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsup"
+
+export default defineConfig({
+  format: ["cjs", "esm"],
+  entry: ["./src/index.ts"],
+  dts: true,
+  shims: true,
+  skipNodeModulesBundle: true,
+  clean: true
+})