feat: changesets CI + add docusarus template

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/angry-bears-fail.md

@@ -0,0 +1,5 @@
+---
+"fs-prober": patch
+---
+
+add changeset + docs template

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.4/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": ["docs"]
+}

.github/CODEOWNERS

@@ -0,0 +1,5 @@
+# Learn how to add code owners here:
+
+# https://help.github.com/en/articles/about-code-owners
+
+*          @ashuvssut

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zero@0chain.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to this project. There are just a few guidelines you need to follow.
+
+## Code reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
+
+## Community Guidelines
+
+This project follows [Contributor Covenant](https://www.contributor-covenant.org/)
+as it's Code of Conduct, and we expect all project participants to adhere to it.
+Please read the [full guide](./CODE_OF_CONDUCT.md) so that you can 
+understand what actions will not be tolerated.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Browser details (please complete the following information):**
+ - Browser [e.g. Chrome, Safari, Android Chrome]
+ - Version [e.g. 22.0.1234]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/MAINTAINERS

@@ -0,0 +1 @@
+ashuvssut

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+Fixes #<issue_number_goes_here>
+
+> It's a good idea to open an issue first for discussion.
+
+- [ ] Tests Pass
+- [ ] The changeset and appropriate docs changes / examples have been included in PR

.github/misc/npm-publish.yml

@@ -0,0 +1,60 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  workflow_dispatch:
+
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: arc-runner
+    steps:
+      - name: Action checkout.
+        uses: actions/checkout@v3
+
+      - name: Setting up Node.
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Installing yarn.
+        run: |
+          npm install --global yarn
+
+      - name: Installing dependencies.
+        run: |
+          yarn install --frozen-lockfile
+
+      - name: Running Tests.
+        run: |
+          yarn test
+
+  publish-npm:
+    needs: build
+    runs-on: arc-runner
+    steps:
+      - name: Action checkout.
+        uses: actions/checkout@v3
+
+      - name: Setting up Node.
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+
+      - name: Installing yarn.
+        run: |
+          npm install --global yarn
+
+      - name: Installing dependencies.
+        run: |
+          yarn install --frozen-lockfile
+
+      - name: Creating build.
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token2}}

.github/workflows/changeset-publish.yml

@@ -0,0 +1,48 @@
+name: Release
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Setting up Node LTS
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          cache: "yarn"
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Installing dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Create Release Pull Request or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          publish: yarn publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Export Error Logs as an Artifact
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: NPM error-logs
+          path: /home/runner/.npm/_logs/

.github/workflows/pull_request_code_quality.yml

@@ -2,34 +2,45 @@ name: Code Quality
 
 on:
   push:
+    branches:
+      - main
+      - dev
   pull_request:
 
 jobs:
   quality:
+    name: Code Quality
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Setup Node.js 20.x
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Setting up Node LTS
         uses: actions/setup-node@v4
         with:
-          node-version: 20.x
+          node-version: "lts/*"
+          cache: "yarn"
           registry-url: "https://registry.npmjs.org"
 
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Install yarn
-        run: yarn install
+      - name: Installing dependenciesn
+        run: yarn install --frozen-lockfile
 
       - name: Setup Biome
         uses: biomejs/setup-biome@v2
         with:
           version: latest
 
       - name: Run Biome
+        working-directory: package
         run: biome ci .
 
-      - name: Run TypeScript Check
-        run: npx tsc --noEmit
+      - name: Run Package Lint
+        working-directory: package
+        run: yarn lint
+
+      - name: Run Package Build
+        working-directory: package
+        run: yarn build

.github/workflows/pull_request_reviewdog.yml

@@ -2,7 +2,7 @@ name: reviewdog
 on: [pull_request]
 jobs:
   biome:
-    name: runner / Biome
+    name: Reviewdog runner / Biome
     runs-on: ubuntu-latest
     permissions:
       contents: read

FsProber.code-workspace

@@ -3,6 +3,14 @@
     {
       "name": "Root",
       "path": "."
+    },
+    {
+      "name": "Docs",
+      "path": "./docs/"
+    },
+    {
+      "name": "Package",
+      "path": "./package/"
     }
   ],
   "settings": {

biome.json

@@ -80,6 +80,9 @@
     "useIgnoreFile": true
   },
   "json": {
+    "formatter": {
+      "enabled": false
+    },
     "parser": {
       "allowComments": true
     }