Skip to content

refactor(bananass): minor tweaks and cleanup #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 20, 2025

Conversation

lumirlumir
Copy link
Owner

This pull request introduces several updates across multiple files, focusing on improving code consistency, adding functionality for file extensions, and refining documentation. Below is a categorized summary of the most important changes:

Code Consistency Improvements:

  • Updated all functions in packages/bananass/src/commands to use a default parameter [configObject = dco] for ConfigObject, ensuring consistent function signatures. [1] [2] [3] [4] [5] [6] [7]
  • Added ESLint rules for sorting imports and keys in packages/bananass/src/commands/index.js to enforce consistent code style.

Functional Enhancements:

  • Introduced a new constant DEFAULT_OUT_FILE_EXTENSION in packages/bananass/src/core/constants.js to define the default output file extension as .cjs.
  • Updated the build.js file to use DEFAULT_OUT_FILE_EXTENSION for output filenames, replacing hardcoded .cjs values. [1] [2]

Documentation Updates:

  • Expanded the @fileoverview in build.js to include Babel as part of the build process, reflecting the current functionality.

Minor Text Adjustments:

  • Corrected a minor translation inconsistency in SECURITY.md by replacing "종속성" with "의존성" for better readability.

@Copilot Copilot AI review requested due to automatic review settings April 20, 2025 08:21
Copy link

vercel bot commented Apr 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
npm-bananass-websites-vitepress ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 20, 2025 8:21am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
npm-bananass-websites-eslint-config-bananass ⬜️ Skipped (Inspect) Apr 20, 2025 8:21am

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces minor refactoring and cleanup across the codebase. The changes focus on standardizing function signatures by adding default parameters, enforcing ESLint rules for consistent code style, and enhancing functionality with a new constant for output file extensions, along with some documentation and translation tweaks.

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/bananass/src/core/constants.js Added DEFAULT_OUT_FILE_EXTENSION for file output names
packages/bananass/src/commands/index.js Inserted ESLint rules for import and key sorting
packages/bananass/src/commands/bananass-run/run.js Updated jsdoc and default parameter for configObject
packages/bananass/src/commands/bananass-repo/repo.js Updated jsdoc for configObject default parameter
packages/bananass/src/commands/bananass-open/open.js Updated jsdoc for configObject default parameter
packages/bananass/src/commands/bananass-info/info.js Updated jsdoc for configObject default parameter
packages/bananass/src/commands/bananass-home/home.js Updated jsdoc for configObject default parameter
packages/bananass/src/commands/bananass-discussion/discussion.js Updated jsdoc for configObject default parameter
packages/bananass/src/commands/bananass-build/build.js Adjusted documentation and output filename construction
packages/bananass/src/commands/bananass-bug/bug.js Updated jsdoc for configObject default parameter
SECURITY.md Corrected translation for clarity

@github-actions github-actions bot added 🏷️ scope: bananass Auto-generated label based on Conventional Commits specification for GitHub release notes 🏷️ type: refactor Auto-generated label based on Conventional Commits specification for GitHub release notes labels Apr 20, 2025
Copy link

Labels have been automatically applied based on the Conventional Commits specification.🏷️

Copy link

codecov bot commented Apr 20, 2025

Bundle Report

Changes will decrease total bundle size by 698.38kB (-46.43%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
websites-vitepress-esm 478.93kB -698.38kB (-59.32%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: websites-vitepress-esm

Assets Changed:

Asset Name Size Change Total Size Change (%)
app.js (New) 209.97kB 209.97kB 100.0% 🚀
learn_how-to-parse-input-value.*.js (New) 79.15kB 79.15kB 100.0% 🚀
index.*.js (New) 41.77kB 41.77kB 100.0% 🚀
en_index.*.js (New) 41.05kB 41.05kB 100.0% 🚀
@localSearchIndexroot.*.js (New) 40.85kB 40.85kB 100.0% 🚀
learn_solving-problems-without-bananass-framework.*.js (New) 30.04kB 30.04kB 100.0% 🚀
VPLocalSearchBox.*.js (New) 18.93kB 18.93kB 100.0% 🚀
get-started_installation.*.js (New) 10.77kB 10.77kB 100.0% 🚀
@localSearchIndexen.*.js (New) 1.78kB 1.78kB 100.0% 🚀
en_learn_solving-problems-without-bananass-framework.*.js (New) 1.75kB 1.75kB 100.0% 🚀
en_learn_how-to-parse-input-value.*.js (New) 1.38kB 1.38kB 100.0% 🚀
en_get-started_installation.*.js (New) 1.28kB 1.28kB 100.0% 🚀
plugin-vue_export-helper.*.js (New) 191 bytes 191 bytes 100.0% 🚀
package.json (New) 37 bytes 37 bytes 100.0% 🚀
assets/inter-italic-latin-ext.*.woff2 (Deleted) -120.84kB 0 bytes -100.0% 🗑️
assets/inter-roman-latin-ext.*.woff2 (Deleted) -110.16kB 0 bytes -100.0% 🗑️
assets/chunks/framework.-a8jReyC.js (Deleted) -107.06kB 0 bytes -100.0% 🗑️
assets/inter-italic-latin.*.woff2 (Deleted) -74.78kB 0 bytes -100.0% 🗑️
assets/inter-roman-latin.*.woff2 (Deleted) -67.79kB 0 bytes -100.0% 🗑️
assets/learn_how-to-parse-input-value.md.BE22vH3J.js (Deleted) -64.76kB 0 bytes -100.0% 🗑️
assets/chunks/VPLocalSearchBox.z0iRNEPu.js (Deleted) -61.74kB 0 bytes -100.0% 🗑️
assets/chunks/theme.BdG-uZtj.js (Deleted) -53.55kB 0 bytes -100.0% 🗑️
assets/inter-italic-cyrillic-ext.*.woff2 (Deleted) -43.11kB 0 bytes -100.0% 🗑️
assets/index.md.RieQWo78.js (Deleted) -41.21kB 0 bytes -100.0% 🗑️
assets/index.md.RieQWo78.lean.js (Deleted) -41.21kB 0 bytes -100.0% 🗑️
assets/chunks/@localSearchIndexroot.Dm02agGu.js (Deleted) -41.01kB 0 bytes -100.0% 🗑️
assets/en_index.md.CZn2Yn8n.js (Deleted) -40.49kB 0 bytes -100.0% 🗑️
assets/en_index.md.CZn2Yn8n.lean.js (Deleted) -40.49kB 0 bytes -100.0% 🗑️
assets/inter-roman-cyrillic-ext.*.woff2 (Deleted) -40.49kB 0 bytes -100.0% 🗑️
assets/inter-italic-greek.*.woff2 (Deleted) -32.56kB 0 bytes -100.0% 🗑️
assets/inter-italic-cyrillic.*.woff2 (Deleted) -31.3kB 0 bytes -100.0% 🗑️
assets/inter-roman-greek.*.woff2 (Deleted) -29.92kB 0 bytes -100.0% 🗑️
assets/inter-roman-cyrillic.*.woff2 (Deleted) -29.16kB 0 bytes -100.0% 🗑️
assets/learn_solving-problems-without-bananass-framework.md._KzPPXeM.js (Deleted) -23.58kB 0 bytes -100.0% 🗑️
assets/inter-italic-greek-ext.*.woff2 (Deleted) -17.4kB 0 bytes -100.0% 🗑️
assets/inter-roman-greek-ext.*.woff2 (Deleted) -16.27kB 0 bytes -100.0% 🗑️
assets/inter-italic-vietnamese.*.woff2 (Deleted) -14.88kB 0 bytes -100.0% 🗑️
assets/inter-roman-vietnamese.*.woff2 (Deleted) -14.07kB 0 bytes -100.0% 🗑️
assets/get-started_installation.md.CjKxDgj2.js (Deleted) -9.44kB 0 bytes -100.0% 🗑️
assets/chunks/@localSearchIndexen.CViqF3zz.js (Deleted) -1.73kB 0 bytes -100.0% 🗑️
assets/app.CtrwNrHV.js (Deleted) -1.35kB 0 bytes -100.0% 🗑️
assets/en_learn_solving-problems-without-bananass-framework.md.CgoiserS.js (Deleted) -1.12kB 0 bytes -100.0% 🗑️
assets/en_learn_solving-problems-without-bananass-framework.md.CgoiserS.lean.js (Deleted) -1.12kB 0 bytes -100.0% 🗑️
assets/en_learn_how-to-parse-input-value.md.BMZ5VOF3.js (Deleted) -813 bytes 0 bytes -100.0% 🗑️
assets/en_learn_how-to-parse-input-value.md.BMZ5VOF3.lean.js (Deleted) -813 bytes 0 bytes -100.0% 🗑️
assets/en_get-started_installation.md.BCvm-BO_.js (Deleted) -735 bytes 0 bytes -100.0% 🗑️
assets/en_get-started_installation.md.BCvm-BO_.lean.js (Deleted) -735 bytes 0 bytes -100.0% 🗑️
assets/learn_solving-problems-without-bananass-framework.md._KzPPXeM.lean.js (Deleted) -621 bytes 0 bytes -100.0% 🗑️
assets/learn_how-to-parse-input-value.md.BE22vH3J.lean.js (Deleted) -490 bytes 0 bytes -100.0% 🗑️
assets/get-started_installation.md.CjKxDgj2.lean.js (Deleted) -462 bytes 0 bytes -100.0% 🗑️

@lumirlumir lumirlumir merged commit 7db03ca into main Apr 20, 2025
11 checks passed
@lumirlumir lumirlumir deleted the refactor-minor-tweaks-and-cleanup branch April 20, 2025 08:22
Copy link

codecov bot commented Apr 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.32%. Comparing base (1c5fc00) to head (5c04915).
Report is 1 commits behind head on main.

@@           Coverage Diff           @@
##             main     #343   +/-   ##
=======================================
  Coverage   98.32%   98.32%           
=======================================
  Files         162      162           
  Lines        9664     9664           
  Branches       16       16           
=======================================
  Hits         9502     9502           
  Misses        162      162           
Files with missing lines Coverage Δ
packages/bananass/src/commands/bananass-bug/bug.js 100.00% <100.00%> (ø)
...ages/bananass/src/commands/bananass-build/build.js 95.21% <100.00%> (+0.06%) ⬆️
...ass/src/commands/bananass-discussion/discussion.js 100.00% <100.00%> (ø)
...ckages/bananass/src/commands/bananass-home/home.js 100.00% <100.00%> (ø)
...ckages/bananass/src/commands/bananass-info/info.js 100.00% <100.00%> (ø)
...ckages/bananass/src/commands/bananass-open/open.js 100.00% <100.00%> (ø)
...ckages/bananass/src/commands/bananass-repo/repo.js 100.00% <100.00%> (ø)
packages/bananass/src/commands/bananass-run/run.js 94.00% <100.00%> (-0.03%) ⬇️
packages/bananass/src/commands/index.js 100.00% <100.00%> (ø)
packages/bananass/src/core/constants.js 100.00% <100.00%> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c5fc00...5c04915. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

lumirlumir added a commit that referenced this pull request Apr 24, 2025
….0-canary.3` (`prerelease`) (#362)

## Release Information: `v0.1.0-canary.3`

New release of `lumirlumir/npm-bananass` has arrived! 🎉

This PR bumps the package versions from `v0.1.0-canary.2` to
`v0.1.0-canary.3` (`prerelease`).

See
[Actions](https://github.com/lumirlumir/npm-bananass/actions/runs/14634205891)
for more details.

| Info        | Value                      |
| ----------- | -------------------------- |
| Repository  | `lumirlumir/npm-bananass` |
| SEMVER      | `prerelease`     |
| Pre ID      | `canary`      |
| Short SHA   | cf78531       |
| Old Version | `v0.1.0-canary.2`  |
| New Version | `v0.1.0-canary.3`  |

<!-- Release notes generated using configuration in .github/release.yml
at main -->

## What's Changed
### ✨ Features
* feat(bananass): support `Array.prototype.toSorted` transpilation using
custom babel plugin by @lumirlumir in
#350
* feat(bananass): support `Array.prototype.toReversed` transpilation
using custom babel plugin by @lumirlumir in
#351
* feat(bananass): support `Object.hasOwn` transpilation using custom
babel plugin by @lumirlumir in
#356
* feat(bananass): add support computed bracket form for `toSorted` and
`toReversed` by @lumirlumir in
#357
### 🐛 Bug Fixes
* fix(eslint-config-bananass): enhance JSDoc template and update types
in `index.js` by @lumirlumir in
#338
* fix(bananass): replace esbuild loader with babel loader for js code
bundling by @lumirlumir in
#344
* fix(bananass): drop esbuild-loader and create e2e tests for bananass
build with mts module system by @lumirlumir in
#360
* fix(bananass): fix `.cts` module interop and create e2e tests for
bananass build with `cts` module system by @lumirlumir in
#361
### 🧰 Chores
* chore(*): install `@types/node` and update `lint-staged` configuration
by @lumirlumir in #337
### 📝 Documentation
* docs(*): update `README.md`, `README.en.md`, and `CONTRIBUTING.md` by
@lumirlumir in #336
### ♻️ Code Refactoring
* refactor(bananass): minor tweaks and cleanup by @lumirlumir in
#343
* refactor(bananass): remove unused cli commands (`random`, `testcase`)
and cleanup by @lumirlumir in
#359
### 🧪 Tests
* test(*): create e2e tests for bananass-build with `cjs` module system
by @lumirlumir in #341
* test(tests-e2e): create e2e tests for bananass build with `mjs` module
system by @lumirlumir in
#342
* test(*): create integration tests for package json `engines.node`
field by @lumirlumir in
#358
### ⬆️ Dependency Updates
* chore(deps): bump the typescript-eslint group across 2 directories
with 2 updates by @dependabot in
#331
* chore(deps-dev): bump vitepress-plugin-group-icons from 1.5.1 to 1.5.2
by @dependabot in #332
* chore(deps): bump open from 10.1.0 to 10.1.1 by @dependabot in
#334
* chore(deps): bump the next group across 2 directories with 1 update by
@dependabot in #340
* chore(deps): bump webpack from 5.99.5 to 5.99.6 by @dependabot in
#345
* chore(deps-dev): bump eslint from 9.24.0 to 9.25.0 by @dependabot in
#347
* chore(deps): bump the typescript-eslint group across 2 directories
with 2 updates by @dependabot in
#352
* chore(deps-dev): bump eslint from 9.25.0 to 9.25.1 by @dependabot in
#353


**Full Changelog**:
v0.1.0-canary.2...v0.1.0-canary.3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ scope: bananass Auto-generated label based on Conventional Commits specification for GitHub release notes 🏷️ type: refactor Auto-generated label based on Conventional Commits specification for GitHub release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy