Rename and update configs

alpheustangs · Jul 20, 2024 · 4bd81fb · 4bd81fb
1 parent 56bbfff
commit 4bd81fb
Show file tree

Hide file tree

Showing 30 changed files with 1,747 additions and 2,242 deletions.
diff --git a/README.md b/README.md
@@ -8,13 +8,13 @@ For TypeScript / JavaScript environment:
 
 ```bash
 # NPM
-npm install @filego/ts
+npm install @filego/js
 
 # Yarn
-yarn add @filego/ts
+yarn add @filego/js
 
 # PNPM
-pnpm add @filego/ts
+pnpm add @filego/js
 ```
 
 For Node environment:
@@ -44,7 +44,7 @@ await split({
 });
 ```
 
-For the usage of `@filego/ts`, please refer to [docs/ts.md](./docs/ts.md).
+For the usage of `@filego/js`, please refer to [docs/js.md](./docs/js.md).
 
 For the usage of `@filego/node`, please refer to [docs/node.md](./docs/node.md).
 

diff --git a/docs/ts.md → docs/js.md b/docs/ts.md → docs/js.md
@@ -1,32 +1,32 @@
-# Usage of `@filego/ts`
+# Usage of `@filego/js`
 
-This documentation provides the usage of `@filego/ts`.
+This documentation provides the usage of `@filego/js`.
 
 ## Installation
 
-Install `@filego/ts` as a dependency:
+Install `@filego/js` as a dependency:
 
 ```bash
 # NPM
-npm install @filego/ts
+npm install @filego/js
 
 # Yarn
-yarn add @filego/ts
+yarn add @filego/js
 
 # PNPM
-pnpm add @filego/ts
+pnpm add @filego/js
 ```
 
 ## Functions
 
-`@filego/ts` provides the following functions:
+`@filego/js` provides the following functions:
 
 #### `split`
 
 This function splits file into chunks, and the chunks can be used to check and merge later. It will return the `chunks`, `fileSize` and `totalChunks`.
 
 ```typescript
-import { split } from "@filego/ts";
+import { split } from "@filego/js";
 
 const file: File | Blob | Uint8Array | string = "";
 
@@ -41,7 +41,7 @@ await split({
 This function checks file integrity by verifying the `chunks` with `fileSize` and `totalChunks` parameters. It will return the `status` and the `error` of the check.
 
 ```typescript
-import { check } from "@filego/ts";
+import { check } from "@filego/js";
 
 await check({
     chunks: [], // result from split function...
@@ -55,7 +55,7 @@ await check({
 This function merges the chunks by using the `chunks` parameters. It will return the `blob` and `buffer` of the merged file.
 
 ```typescript
-import { merge } from "@filego/ts";
+import { merge } from "@filego/js";
 
 await merge({
     chunks: [], // result from split function...

diff --git a/examples/web/package.json b/examples/web/package.json
@@ -7,7 +7,7 @@
         "preview": "vite preview"
     },
     "dependencies": {
-        "@filego/ts": "workspace:^",
+        "@filego/js": "workspace:^",
         "react": "^18.2.0",
         "react-dom": "^18.2.0"
     },

diff --git a/examples/web/src/app.tsx b/examples/web/src/app.tsx
@@ -1,8 +1,8 @@
-import type { FileChunk, SplitResult } from "@filego/ts";
+import type { FileChunk, SplitResult } from "@filego/js";
 
 import * as React from "react";
 
-import { split } from "@filego/ts";
+import { split } from "@filego/js";
 
 type APIResponse<Data> = {
     status: "success" | "error";

diff --git a/examples/web/vite.config.ts b/examples/web/vite.config.ts
@@ -4,7 +4,7 @@ import react from "@vitejs/plugin-react-swc";
 
 export default defineConfig({
     optimizeDeps: {
-        include: ["@filego/ts"],
+        include: ["@filego/js"],
     },
     server: {
         port: 3001,

diff --git a/package.json b/package.json
@@ -2,14 +2,14 @@
     "private": true,
     "scripts": {
         "format": "biome check --write .",
-        "build": "npm-run-all --sequential build:shared build:node build:ts",
+        "build": "npm-run-all --sequential build:shared build:node build:js",
         "build:shared": "cd ./packages/shared && tsc && tsc-alias",
         "build:node": "cd ./packages/node && tsc && tsc-alias",
-        "build:ts": "cd ./packages/ts && tsc && tsc-alias",
-        "test": "npm-run-all --sequential test:shared test:node test:ts",
+        "build:js": "cd ./packages/js && tsc && tsc-alias",
+        "test": "npm-run-all --sequential test:shared test:node test:js",
         "test:shared": "cd ./tests/shared && pnpm run build",
         "test:node": "cd ./tests/node && pnpm run test",
-        "test:ts": "cd ./tests/ts && pnpm run test",
+        "test:js": "cd ./tests/js && pnpm run test",
         "node": "cd ./examples/node && pnpm run dev",
         "web": "cd ./examples/web && pnpm run dev",
         "": ""

diff --git a/packages/ts/CHANGELOG.md → packages/js/CHANGELOG.md b/packages/ts/CHANGELOG.md → packages/js/CHANGELOG.md
diff --git a/packages/ts/README.md → packages/js/README.md b/packages/ts/README.md → packages/js/README.md
@@ -7,7 +7,7 @@ A file splitting & merging solution.
 Split file from a path with `split` function.
 
 ```typescript
-import { split } from "@filego/ts";
+import { split } from "@filego/js";
 
 const file: File | Blob | Uint8Array | string = "";
 

diff --git a/packages/ts/package.json → packages/js/package.json b/packages/ts/package.json → packages/js/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "@filego/ts",
+    "name": "@filego/js",
     "version": "0.3.1",
     "description": "A file splitting & merging solution",
     "keywords": [
@@ -24,17 +24,17 @@
         "js",
         "JavaScript"
     ],
-    "homepage": "https://github.com/alpheustangs/filego.ts",
-    "bugs": "https://github.com/alpheustangs/filego.ts/issues",
+    "homepage": "https://github.com/alpheustangs/filego.js",
+    "bugs": "https://github.com/alpheustangs/filego.js/issues",
     "license": "MIT",
     "author": "Alpheus Tang",
     "files": ["dist"],
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://github.com/alpheustangs/filego.ts.git",
-        "directory": "packages/ts"
+        "url": "https://github.com/alpheustangs/filego.js.git",
+        "directory": "packages/js"
     },
     "dependencies": {
         "@filego/shared": "workspace:~"

diff --git a/packages/ts/src/base/check.ts → packages/js/src/base/check.ts b/packages/ts/src/base/check.ts → packages/js/src/base/check.ts
@@ -35,7 +35,7 @@ type CheckOptions = _CheckOptions & {
  * ## Example
  *
  * ```typescript
- * import { check } from "@filego/ts";
+ * import { check } from "@filego/js";
  *
  * await check({
  *     chunks: [], // result from split function...

diff --git a/packages/ts/src/base/merge.ts → packages/js/src/base/merge.ts b/packages/ts/src/base/merge.ts → packages/js/src/base/merge.ts
@@ -33,7 +33,7 @@ type MergeOptions = _MergeOptions & {
  * ## Example
  *
  * ```typescript
- * import { merge } from "@filego/ts";
+ * import { merge } from "@filego/js";
  *
  * await merge({
  *     chunks: [], // result from split function...

diff --git a/packages/ts/src/base/split.ts → packages/js/src/base/split.ts b/packages/ts/src/base/split.ts → packages/js/src/base/split.ts
@@ -44,7 +44,7 @@ const ermsg: string =
  * ## Example
  *
  * ```typescript
- * import { split } from "@filego/ts";
+ * import { split } from "@filego/js";
  *
  * const file: File | Blob | Uint8Array | string = "";
  *

diff --git a/packages/ts/src/index.ts → packages/js/src/index.ts b/packages/ts/src/index.ts → packages/js/src/index.ts
diff --git a/packages/ts/tsconfig.json → packages/js/tsconfig.json b/packages/ts/tsconfig.json → packages/js/tsconfig.json
@@ -1,8 +1,6 @@
 {
     "extends": "../../tsconfig.base.json",
     "compilerOptions": {
-        "target": "ES5",
-        "module": "CommonJS",
         "rootDir": "./src",
         "baseUrl": ".",
         "paths": {

diff --git a/packages/node/package.json b/packages/node/package.json
@@ -24,16 +24,16 @@
         "js",
         "JavaScript"
     ],
-    "homepage": "https://github.com/alpheustangs/filego.ts",
-    "bugs": "https://github.com/alpheustangs/filego.ts/issues",
+    "homepage": "https://github.com/alpheustangs/filego.js",
+    "bugs": "https://github.com/alpheustangs/filego.js/issues",
     "license": "MIT",
     "author": "Alpheus Tang",
     "files": ["dist"],
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://github.com/alpheustangs/filego.ts.git",
+        "url": "https://github.com/alpheustangs/filego.js.git",
         "directory": "packages/node"
     },
     "dependencies": {

diff --git a/packages/node/tsconfig.json b/packages/node/tsconfig.json
@@ -1,8 +1,6 @@
 {
     "extends": "../../tsconfig.base.json",
     "compilerOptions": {
-        "target": "ES5",
-        "module": "CommonJS",
         "rootDir": "./src",
         "baseUrl": ".",
         "paths": {

diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -23,16 +23,16 @@
         "js",
         "JavaScript"
     ],
-    "homepage": "https://github.com/alpheustangs/filego.ts",
-    "bugs": "https://github.com/alpheustangs/filego.ts/issues",
+    "homepage": "https://github.com/alpheustangs/filego.js",
+    "bugs": "https://github.com/alpheustangs/filego.js/issues",
     "license": "MIT",
     "author": "Alpheus Tang",
     "files": ["dist"],
     "main": "./dist/index.js",
     "types": "./dist/index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://github.com/alpheustangs/filego.ts.git",
+        "url": "https://github.com/alpheustangs/filego.js.git",
         "directory": "packages/shared"
     }
 }
diff --git a/packages/shared/tsconfig.json b/packages/shared/tsconfig.json
@@ -1,8 +1,6 @@
 {
     "extends": "../../tsconfig.base.json",
     "compilerOptions": {
-        "target": "ES5",
-        "module": "CommonJS",
         "rootDir": "./src",
         "baseUrl": ".",
         "paths": {