Skip to content
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

feat: update package.json while preserve indent & eol style #129

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Waleed-KH
Copy link
Contributor

πŸ”— Linked issue

❓ Type of change

  • πŸ“– Documentation (updates to the documentation, readme, or JSdoc annotations)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

Use jsonc-parser to modify the package json string to preserve its indent & eol style

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@pi0
Copy link
Member

pi0 commented Aug 22, 2023

Thanks for this PR! Pending it for unjs/pkg-types#125 (and possible auto detection) from pkg-types to leverage.

@pi0 pi0 marked this pull request as draft August 22, 2023 11:53
@Waleed-KH
Copy link
Contributor Author

Hi, thanks for the reply, even with unjs/pkg-types#125, I still prefer the approach in this PR because it achieves the target (update version, name props) wihout having to stringify the whole package object and lose the original indent & eol style.

If we want pkg-types to leverage something similar, I think we will need a load function that returns a Proxy object to track the changes and have save function to apply the changes to the file, and then we can do something like this:

import { loadPackageJSON } from 'pkg-types';

const package = await loadPackageJSON();
package.version = '2.0.0';
await package.save();

@pi0
Copy link
Member

pi0 commented Aug 22, 2023

Sure that's i deam too! With unjs/magicast we do similar thing and auto detect original identation and line endings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants