docs(website): add packages and releases sections

bugra9 · Jan 15, 2025 · de2f9c4 · de2f9c4
1 parent a49d52a
commit de2f9c4
Show file tree

Hide file tree

Showing 92 changed files with 1,364 additions and 410 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Buğra Sarı
+Copyright (c) 2025 Buğra Sarı
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/package.json b/package.json
@@ -21,7 +21,6 @@
         "clear:samples": "pnpm run clear:cache:samples; pnpm run clear:dist:samples",
         "clear:packages": "pnpm run clear:cache:package; pnpm run clear:dist:package",
         "pack:list": "find packages -name \"*.tgz\" -type d -maxdepth 2",
-        "pack:build": "pnpm pack:clear; node ./scripts/pack-all.mjs && pnpm pack:list",
         "ci:linux:build:package": "pnpm --filter=@cpp.js/package-zlib run build",
         "ci:linux:build": "pnpm run build:samples && pnpm run ci:linux:build:package",
         "ci:windows:build": "pnpm run build:samples:lib:wasm && pnpm run build:samples:lib:android && pnpm run ci:linux:build:package",

diff --git a/packages/cpp.js/README.md b/packages/cpp.js/README.md
@@ -28,15 +28,15 @@
   <span> · </span>
   <a href="https://cpp.js.org/docs/api/cpp-bindings/overview">C++ Bindings</a>
   <span> · </span>
-  <a href="https://cpp.js.org/showcase">Showcase</a>
+  <a href="https://cpp.js.org/docs/package/package/showcase">Showcase</a>
 </h3>
 
 ## Basic Usage
 **src/index.js**
 ```js
-import { initCppJs } from './native/Factorial.h';
+import { initCppJs, Factorial } from './native/Factorial.h';
 
-const { Factorial } = await initCppJs();
+await initCppJs();
 const factorial = new Factorial(99999);
 const result = factorial.calculate();
 console.log(result);
@@ -77,30 +77,8 @@ To set up a new cpp.js project with a minimal starter structure, execute the fol
 ```sh
 npm create cpp.js@latest
 ```
-## Integrate Into Existing Project
-Integrate cpp.js seamlessly into your existing projects using the appropriate packages for your development needs. Refer to the documentation links for detailed integration guides.
-
-| Platform | Package(s) | Documentation |
-| -------- | ---------- | ------------- |
-| Standalone  | [cpp.js](https://www.npmjs.com/package/cpp.js) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/standalone) |
-| Webpack  | [@cpp.js/plugin-webpack](https://www.npmjs.com/package/@cpp.js/plugin-webpack), [@cpp.js/plugin-webpack-loader](https://www.npmjs.com/package/@cpp.js/plugin-webpack-loader) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/webpack) |
-| Rollup  | [@cpp.js/plugin-rollup](https://www.npmjs.com/package/@cpp.js/plugin-rollup) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/rollup) |
-| Vite  | [@cpp.js/plugin-vite](https://www.npmjs.com/package/@cpp.js/plugin-vite) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/vite) |
-| Rspack  | [@cpp.js/plugin-webpack](https://www.npmjs.com/package/@cpp.js/plugin-webpack), [@cpp.js/plugin-webpack-loader](https://www.npmjs.com/package/@cpp.js/plugin-webpack-loader) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/rspack) |
-| Create React App (CRA) | [@cpp.js/plugin-webpack](https://www.npmjs.com/package/@cpp.js/plugin-webpack), [@cpp.js/plugin-webpack-loader](https://www.npmjs.com/package/@cpp.js/plugin-webpack-loader) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/create-react-app) |
-| React Native | [@cpp.js/plugin-react-native](https://www.npmjs.com/package/@cpp.js/plugin-react-native), [@cpp.js/plugin-react-native-ios-helper](https://www.npmjs.com/package/@cpp.js/plugin-react-native-ios-helper), [@cpp.js/plugin-metro](https://www.npmjs.com/package/@cpp.js/plugin-metro), [@cpp.js/core-embind-jsi](https://www.npmjs.com/package/@cpp.js/core-embind-jsi) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/react-native) |
-| Expo | [@cpp.js/plugin-react-native](https://www.npmjs.com/package/@cpp.js/plugin-react-native), [@cpp.js/plugin-react-native-ios-helper](https://www.npmjs.com/package/@cpp.js/plugin-react-native-ios-helper), [@cpp.js/plugin-metro](https://www.npmjs.com/package/@cpp.js/plugin-metro), [@cpp.js/core-embind-jsi](https://www.npmjs.com/package/@cpp.js/core-embind-jsi) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/expo) |
-| Node.js | [cpp.js](https://www.npmjs.com/package/cpp.js) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/nodejs) |
-| Cloudflare Workers  | [cpp.js](https://www.npmjs.com/package/cpp.js) | [Learn](https://cpp.js.org/docs/guide/integrate-into-existing-project/cloudflare-worker) |
-
-## Features
-- [Calling C++ from JavaScript](https://cpp.js.org/docs/guide/features/calling-cpp-from-javascript)
-- [Packages](https://cpp.js.org/docs/guide/features/packages)
-- [Plugins](https://cpp.js.org/docs/guide/features/plugins)
-- [Assets](https://cpp.js.org/docs/guide/features/assets)
-- [Working with a Monorepo](https://cpp.js.org/docs/guide/features/monorepo)
 
 ## License
 [MIT](https://github.com/bugra9/cpp.js/blob/main/LICENSE)
 
-Copyright (c) 2023-2025, Buğra Sarı
+Copyright (c) 2025, Buğra Sarı
diff --git a/packages/cpp.js/src/bin.js b/packages/cpp.js/src/bin.js
@@ -42,7 +42,7 @@ commandDocker.command('stop').description('stop docker container');
 commandDocker.command('delete').description('delete docker container');
 
 const commandConfig = program.command('config')
-    .description('Manage the Cpp.js configuration files');
+    .description('manage the Cpp.js configuration files');
 commandConfig.command('get').description('get the Cpp.js system configuration');
 commandConfig.command('set').description('set the Cpp.js system configuration');
 commandConfig.command('delete').description('delete the Cpp.js system configuration');

diff --git a/packages/cppjs-core-create-app/CHANGELOG.md b/packages/cppjs-core-create-app/CHANGELOG.md
@@ -0,0 +1,7 @@
+# create-cpp.js
+
+## 1.0.0-beta.25
+
+### Patch Changes
+
+- chore: add initial version of CHANGELOGS files
diff --git a/packages/cppjs-package-expat/README.md b/packages/cppjs-package-expat/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled expat library, which is distributed under the [MIT License](https://github.com/libexpat/libexpat/blob/master/COPYING).
 
-Expat Homepage: <https://github.com/libexpat/libexpat>
+Expat Homepage: [https://github.com/libexpat/libexpat](https://github.com/libexpat/libexpat)
diff --git a/packages/cppjs-package-gdal/README.md b/packages/cppjs-package-gdal/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled GDAL library, which is distributed under the [MIT License](https://github.com/OSGeo/gdal/blob/master/LICENSE.TXT).
 
-GDAL Homepage: <https://gdal.org/>
+GDAL Homepage: [https://gdal.org/](https://gdal.org/)
diff --git a/packages/cppjs-package-geos/README.md b/packages/cppjs-package-geos/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled geos library, which is distributed under the [LGPL License](https://github.com/libgeos/geos/blob/main/COPYING).
 
-GEOS Homepage: <https://github.com/libgeos/geos>
+GEOS Homepage: [https://github.com/libgeos/geos](https://github.com/libgeos/geos)
diff --git a/packages/cppjs-package-geotiff/README.md b/packages/cppjs-package-geotiff/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled libgeotiff library, which is distributed under the [MIT License](https://github.com/OSGeo/libgeotiff/blob/master/libgeotiff/LICENSE).
 
-GeoTiff Homepage: <https://github.com/OSGeo/libgeotiff>
+GeoTiff Homepage: [https://github.com/OSGeo/libgeotiff](https://github.com/OSGeo/libgeotiff)
diff --git a/packages/cppjs-package-iconv/README.md b/packages/cppjs-package-iconv/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled libiconv library, which is distributed under the [LGPL License](https://spdx.org/licenses/LGPL-2.1-or-later.html).
 
-iconv Homepage: <https://www.gnu.org/software/libiconv/>
+iconv Homepage: [https://www.gnu.org/software/libiconv/](https://www.gnu.org/software/libiconv/)
diff --git a/packages/cppjs-package-proj/README.md b/packages/cppjs-package-proj/README.md
@@ -47,4 +47,4 @@ double Native::sample() {
 ## License
 This project includes the precompiled proj library, which is distributed under the [MIT License](https://github.com/OSGeo/PROJ/blob/master/COPYING).
 
-Proj Homepage: <https://proj.org/>
+Proj Homepage: [https://proj.org/](https://proj.org/)
diff --git a/packages/cppjs-package-spatialite/README.md b/packages/cppjs-package-spatialite/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled spatialite library, which is distributed under the [MPL tri-license](https://website-archive.mozilla.org/www.mozilla.org/mpl/MPL/boilerplate-1.1/mpl-tri-license-html).
 
-Spatialite Homepage: <https://www.gaia-gis.it/fossil/libspatialite/index>
+Spatialite Homepage: [https://www.gaia-gis.it/fossil/libspatialite/index](https://www.gaia-gis.it/fossil/libspatialite/index)
diff --git a/packages/cppjs-package-sqlite3/README.md b/packages/cppjs-package-sqlite3/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled sqlite3 library, which is distributed under the [Public Domain License](https://www.sqlite.org/copyright.html).
 
-Sqlite3 Homepage: <https://www.sqlite.org>
+Sqlite3 Homepage: [https://www.sqlite.org](https://www.sqlite.org)
diff --git a/packages/cppjs-package-tiff/README.md b/packages/cppjs-package-tiff/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled tiff library, which is distributed under the [libtiff License](https://libtiff.gitlab.io/libtiff/project/license.html).
 
-Tiff Homepage: <https://libtiff.gitlab.io/libtiff/index.html>
+Tiff Homepage: [https://libtiff.gitlab.io/libtiff/index.html](https://libtiff.gitlab.io/libtiff/index.html)
diff --git a/packages/cppjs-package-webp/README.md b/packages/cppjs-package-webp/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled webp library, which is distributed under the [BSD 3-Clause License](https://chromium.googlesource.com/webm/libwebp/+/refs/heads/main/COPYING).
 
-WebP Homepage: <https://developers.google.com/speed/webp>
+WebP Homepage: [https://developers.google.com/speed/webp](https://developers.google.com/speed/webp)
diff --git a/packages/cppjs-package-zlib/README.md b/packages/cppjs-package-zlib/README.md
@@ -47,4 +47,4 @@ std::string Native::sample() {
 ## License
 This project includes the precompiled zlib library, which is distributed under the [zlib License](https://zlib.net/zlib_license.html).
 
-Zlib Homepage: <https://zlib.net/>
+Zlib Homepage: [https://zlib.net/](https://zlib.net/)
diff --git a/packages/cppjs-sample-lib-cmake/README.md b/packages/cppjs-sample-lib-cmake/README.md
@@ -44,8 +44,8 @@ std::string Native::sample() {
 
 ### Usage in JavaScript Code (web, with plugin)
 ```js
-import { initCppJs } '@cpp.js/sample-lib-cmake/cppjs-lib-samplebasic-cmake/samplebasiccmake.h';
+import { initCppJs, SampleBasicCmake } from '@cpp.js/sample-lib-cmake/cppjs-lib-samplebasic-cmake/samplebasiccmake.h';
 
-const { SampleBasicCmake } = await initCppJs();
+await initCppJs();
 console.log(SampleBasicCmake.sample());
 ```
diff --git a/packages/cppjs-sample-lib-prebuilt-matrix/README.md b/packages/cppjs-sample-lib-prebuilt-matrix/README.md
@@ -47,9 +47,9 @@ std::string Native::sample() {
 
 ### Usage in JavaScript Code (web, with plugin)
 ```js
-import { initCppJs } '@cpp.js/sample-lib-prebuilt-matrix/Matrix.h';
+import { initCppJs, Matrix } from '@cpp.js/sample-lib-prebuilt-matrix/Matrix.h';
 
-const { Matrix } = await initCppJs();
+await initCppJs();
 const a = new Matrix(1210000, 1);
 const b = new Matrix(1210000, 2);
 const result = a.multiple(b);

diff --git a/packages/cppjs-sample-lib-source/README.md b/packages/cppjs-sample-lib-source/README.md
@@ -44,8 +44,8 @@ std::string Native::sample() {
 
 ### Usage in JavaScript Code (web, with plugin)
 ```js
-import { initCppJs } '@cpp.js/sample-lib-source/cppjs-lib-samplebasic/samplebasic.h';
+import { initCppJs, SampleBasic } from '@cpp.js/sample-lib-source/cppjs-lib-samplebasic/samplebasic.h';
 
-const { SampleBasic } = await initCppJs();
+await initCppJs();
 console.log(SampleBasic.sample());
 ```
diff --git a/packages/cppjs-sample-web-react-rspack/src/App.jsx b/packages/cppjs-sample-web-react-rspack/src/App.jsx
@@ -6,7 +6,7 @@ import "./App.css";
 function App() {
 	const [message, setMessage] = useState("compiling ...");
 
-    initCppJs().then(() => {;
+    initCppJs().then(() => {
         setMessage(Native.sample());
     });
 

diff --git a/packages/cppjs-sample-web-vue-vite/src/App.vue b/packages/cppjs-sample-web-vue-vite/src/App.vue
@@ -4,7 +4,7 @@ import { initCppJs, Native } from './native/native.h'
 
 const message = ref("compiling ...")
 
-initCppJs().then(() => {;
+initCppJs().then(() => {
   message.value = Native.sample();
 });
 </script>

diff --git a/scripts/pack-all.mjs b/scripts/pack-all.mjs
diff --git a/website/docs/api/cli/build.md b/website/docs/api/cli/build.md
@@ -5,58 +5,64 @@ Usage: cppjs build [options]
 compile the project that was set up using Cpp.js
 
 Options:
-  -p, --platform <platform>  target platform (choices: "all", "wasm", "android", "ios", default: "all")
+  -p, --platform <platform>  target platform (choices: "All", "WebAssembly", "Android", "iOS", default: "All")
   -h, --help                 display help for command
 ```
 
 <br />
 
 **Output**
 ```
-└── dist
-    ├── mylib.wasm
-    ├── mylib.browser.js
-    ├── mylib.node.js
-    └── prebuilt
-        ├── Android-arm64-v8a
-        │   ├── include
-        │   │   └── ...
-        │   └── lib
-        │       └── mylib.so
-        │
-        ├── Emscripten-x86_64
-        │   ├── include
-        │   │   └── ...
-        │   └── lib
-        │       └── mylib.a
-        │
-        ├── iOS-iphoneos
-        │   ├── include
-        │   │   └── ...
-        │   └── lib
-        │       └── mylib.a
-        │
-        ├── iOS-iphonesimulator
-        │   ├── include
-        │   │   └── ...
-        │   └── lib
-        │       └── mylib.a
-        │
-        ├── mylib.xcframework
-        │   ├── ios-arm64_arm64e
-        │   │   ├── Headers
-        │   │   │   └── ...
-        │   │   └── mylib.a
-        │   │
-        │   ├── ios-arm64_arm64e_x86_64-simulator
-        │   │   ├── Headers
-        │   │   │   └── ...
-        │   │   └── mylib.a
-        │   │
-        │   └── Info.plist
-        │
-        ├── mylib.xcframework.zip
-        └── CMakeLists.txt
+├── dist
+│   ├── mylib.wasm
+│   ├── mylib.browser.js
+│   ├── mylib.node.js
+│   └── prebuilt
+│       ├── Android-arm64-v8a
+│       │   ├── include
+│       │   │   └── ...
+│       │   └── lib
+│       │       └── mylib.so
+│       │
+│       ├── Android-x86_64
+│       │   ├── include
+│       │   │   └── ...
+│       │   └── lib
+│       │       └── mylib.so
+│       │
+│       ├── Emscripten-x86_64
+│       │   ├── include
+│       │   │   └── ...
+│       │   └── lib
+│       │       └── mylib.a
+│       │
+│       ├── iOS-iphoneos
+│       │   ├── include
+│       │   │   └── ...
+│       │   └── lib
+│       │       └── mylib.a
+│       │
+│       ├── iOS-iphonesimulator
+│       │   ├── include
+│       │   │   └── ...
+│       │   └── lib
+│       │       └── mylib.a
+│       │
+│       ├── mylib.xcframework.zip
+│       └── CMakeLists.txt
+|
+└── mylib.xcframework
+    ├── ios-arm64_arm64e
+    │   ├── Headers
+    │   │   └── ...
+    │   └── mylib.a
+    │
+    ├── ios-arm64_arm64e_x86_64-simulator
+    │   ├── Headers
+    │   │   └── ...
+    │   └── mylib.a
+    │
+    └── Info.plist
 
 ```