refactor: re-arch

[cgilbe27]

Summary by CodeRabbit

• New Features

  • Enhanced the release workflow to focus on the main branch and specific repository references.
  • Updated test workflow with additional environment variables and repository checks.
  • Improved code generation with updated import paths and naming conventions.

• Bug Fixes

  • Addressed issues in the version updates of the @nibiruchain/nibijs package.

• Documentation

  • Updated README to reflect the new source code location.
  • Revised HACKING guide with updated script definition paths.
  • Expanded CHANGELOG with a detailed list of recent updates.

• Refactor

  • Streamlined ESLint and Prettier configurations for better code quality.

• Chores

  • Updated .gitignore to include new directories and remove obsolete paths.

• Tests

  • Configured Jest for improved testing with coverage reporting.

[coderabbitai]

Walkthrough

The project has undergone a configuration refinement, focusing on code consistency and workflow optimization. ESLint and Prettier configurations have been tweaked for better code quality, while GitHub Actions now target specific branches and repositories, ensuring a more streamlined CI/CD process. Documentation, code generation, and testing setups have also been updated, reflecting a shift towards a more efficient development pipeline.

Changes

File(s)	Change Summary
.eslintrc.js, .prettierrc.js	Reordered env, modified rules, added endOfLine: "lf".
.github/workflows/release.yaml	Restricted triggers, added repo checkouts, switched to yarn.
.github/workflows/test-ts-sdk.yaml	Renamed workflow, added env vars, repo checkouts, Jest coverage.
.gitignore	Updated ignored paths, removed old entries.
CHANGELOG.md	Documented updates and changes to @nibiruchain/nibijs.
HACKING.md, README.md	Updated file and directory references.
codegen.ts	Modified import paths, loader paths, output configurations.
jest.config.ts	Configured Jest for improved testing practices.

"In the burrow of the code, changes were made,
A hop, a skip, in the CI/CD parade.
🐇 With each commit, we refine and enhance,
Celebrating progress with a little code dance!"

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[cgilbe27]

@coderabbitai review

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 113ca01 and b3dada1.

Files ignored due to filter (15)

• barrelsby.json
• lerna.json
• package-lock.json
• package.json
• packages/indexer-nibi/package.json
• packages/indexer-nibi/tsconfig.json
• packages/nibijs/package.json
• packages/nibijs/tsconfig.json
• packages/protojs/package.json
• packages/protojs/tsconfig.json
• src/sdk/test/mocks/stabletests.csv
• src/sdk/wasm/cw20_base.wasm
• tsconfig.json
• typedoc.json
• yarn.lock

Files selected for processing (10)

• .eslintrc.js (1 hunks)
• .github/workflows/release.yaml (2 hunks)
• .github/workflows/test-ts-sdk.yaml (1 hunks)
• .gitignore (1 hunks)
• .prettierrc.js (1 hunks)
• CHANGELOG.md (1 hunks)
• HACKING.md (1 hunks)
• README.md (1 hunks)
• codegen.ts (1 hunks)
• jest.config.ts (1 hunks)

Files skipped from review due to trivial changes (3)

• .github/workflows/test-ts-sdk.yaml
• HACKING.md
• README.md

Additional comments: 9

.prettierrc.js (1)

• 3-3: The addition of endOfLine: "lf" ensures consistent line endings across different operating systems, which is a good practice for code consistency and can prevent potential issues with git diff on cross-platform development.

.eslintrc.js (2)

• 1-5: The reordering of the env object to place browser before node is a minor change and should not affect the functionality. It may be a stylistic preference or to align with project standards.

• 14-19: The addition of @typescript-eslint/parser as the parser, inclusion of @typescript-eslint and prettier in the plugins array, and the new extends configurations are all standard practices for a TypeScript project using ESLint with Prettier. These changes align the project with common linting configurations for TypeScript.

codegen.ts (2)

• 2-4: The use of change-case-all for the pascalCase function and the custom changeQueryName function for naming conventions are appropriate for a code generation script where consistent and predictable naming is crucial.

• 9-9: The update to the loader path in the schema object to ./src/indexer-nibi/graphql-codegen/codegen-loader.js should be verified to ensure that the new path is correct and the loader file exists at this location.

Verification successful

---

The verification process has confirmed that the codegen-loader.js file exists at the specified path src/indexer-nibi/graphql-codegen/codegen-loader.js. Therefore, the update to the loader path in the schema object is correct.

Scripts Executed

The following scripts were executed for the analysis:

---

Script:

#!/bin/bash
# Verify that the new loader file exists.
fd 'codegen-loader.js' --exec test -f {}

Length of output: 78

---

---

Script:

#!/bin/bash
# Verify that the new loader file exists by using 'fd' to find the file and then checking if the output is not empty.
if fd 'codegen-loader.js'; then
  echo "Loader file exists."
else
  echo "Loader file does not exist."
fi

Length of output: 122

.github/workflows/release.yaml (1)

• 4-4: Restricting the workflow to only run on pushes to the "main" branch is a common practice to ensure that releases are only performed from the stable branch of the project.

jest.config.ts (1)

• 8-50: The Jest configuration file is set up correctly for a TypeScript project, with appropriate coverage options, module resolution settings, and the test environment specified as "node". This is a standard setup for testing a TypeScript codebase.

.gitignore (1)

• 10-13: The addition of docs/, src/protojs/, and src/indexer-nibi/gql/ to the .gitignore file suggests these directories contain generated or non-source-controlled files, which is a common practice. Ensure that these directories should indeed be ignored based on the project's structure.

CHANGELOG.md (1)

• 1-296: The updates to the CHANGELOG.md file are comprehensive and follow the conventional changelog format, providing clear information about bug fixes, features, code refactors, and miscellaneous chores for each version of the @nibiruchain/nibijs package.

[github-actions]

Lines	Statements	Branches	Functions
	96.73% (5861/6059)	98.22% (664/676)	84.72% (183/216)

[coderabbitai]

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between b3dada1 and c6e1a0b.

Files ignored due to filter (1)

• package.json

Files selected for processing (3)

• .github/workflows/release.yaml (2 hunks)
• .github/workflows/test-ts-sdk.yaml (2 hunks)
• jest.config.ts (1 hunks)

Additional comments: 7

.github/workflows/release.yaml (3)

• 4-4: The workflow trigger has been correctly updated to only run on pushes to the "main" branch.

• 19-32: The addition of steps to checkout both the ts-sdk and nibiru repositories is noted. Ensure that the NIBIBOT_GIT_TOKEN secret is properly set up in the repository to avoid access issues.

• 43-59: The use of borales/actions-yarn@v4 for yarn commands is consistent and the environment variables are correctly set for the yarn semantic-release step.

jest.config.ts (1)

• 1-51: The Jest configuration file is well-structured and includes a comprehensive set of configurations. It correctly sets up coverage collection, module mapping, and test environments. Ensure that the baseUrl and paths in compilerOptions are correctly defined in tsconfig to match the moduleNameMapper and modulePaths configurations.

.github/workflows/test-ts-sdk.yaml (3)

• 12-20: The addition of environment variables is noted. Ensure that all secrets and endpoints are correctly configured in the repository settings.

• 28-35: The checkout of the nibiru repository is correctly configured with a specific reference and token. Verify that the NIBIBOT_GIT_TOKEN is properly set up.

• 75-76: The jest-coverage-comment action is correctly configured with the path to the coverage summary. Ensure that the action version is pinned to a specific commit or version for stability and security.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c6e1a0b and 6723ba1.

Files selected for processing (1)

• .github/workflows/test-ts-sdk.yaml (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/test-ts-sdk.yaml

[coderabbitai]

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 6723ba1 and 95b935f.

Files selected for processing (2)

• .github/workflows/release.yaml (2 hunks)
• .github/workflows/test-ts-sdk.yaml (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/release.yaml

Additional comments: 9

.github/workflows/test-ts-sdk.yaml (9)

• 12-20: The addition of environment variables is a good practice for maintaining sensitive data and configuration settings. Ensure that the secrets and endpoints are correctly set in the repository's settings.

• 22-26: The checkout step for the ts-sdk repository is correctly configured with a shallow clone disabled, which is beneficial for analysis tools that may need the full history.

• 28-35: The checkout step for the nibiru repository is correctly configured with a shallow clone disabled and uses a specific ref, which is good for ensuring consistency in the CI environment. The use of a secret token is also noted, which should be kept secure.

• 42-42: The previous comment regarding the cache-dependency-path is still valid. The glob pattern may not be necessary if there's only one yarn.lock file at the root. Specifying the exact path can improve clarity and performance.

• 47-48: The yarn install command is correctly scoped to the ts-sdk directory using the dir parameter. This ensures that the dependencies for the specific project are installed.

• 54-54: The yarn build command is also scoped to the ts-sdk directory, which is consistent with the previous step and ensures that the build process is contained within the correct context.

• 64-64: The previous comment about changing directory with cd ts-sdk is still valid. The working-directory key should be used for steps instead of cd to ensure that the working directory change persists for subsequent commands.

• 71-71: The yarn test command is scoped to the ts-sdk directory, which is consistent with the previous steps and ensures that tests are run in the correct context.

• 75-76: The addition of a step for Jest coverage comment is a good practice for visibility into test coverage. The path to the coverage summary is specified, which should be verified to ensure it matches the actual output location of the Jest coverage report.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 95b935f and b5e6108.

Files selected for processing (1)

• .github/workflows/test-ts-sdk.yaml (2 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/test-ts-sdk.yaml

[github-actions]

Lines	Statements	Branches	Functions
	96.73% (5861/6059)	98.22% (664/676)	84.72% (183/216)

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 7ab38ab and 104c32f.

Files selected for processing (1)

• .github/workflows/test-ts-sdk.yaml (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/test-ts-sdk.yaml

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 104c32f and af6c560.

Files selected for processing (1)

• .github/workflows/test-ts-sdk.yaml (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/test-ts-sdk.yaml

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between af6c560 and 32f6617.

Files selected for processing (1)

• .github/workflows/test-ts-sdk.yaml (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/test-ts-sdk.yaml

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 32f6617 and f7ba50e.

Files selected for processing (1)

• .github/workflows/test-ts-sdk.yaml (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/test-ts-sdk.yaml

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between f7ba50e and 5cadc17.

Files selected for processing (1)

• .github/workflows/test-ts-sdk.yaml (3 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/test-ts-sdk.yaml