docs: add more usage info

unjs / unbuild

📦 An unified javascript build system

MIT License

2.19k stars 84 forks source link

docs: add more usage info #401

Open RSS1102 opened 3 weeks ago

RSS1102 commented 3 weeks ago

🔗 Linked issue

❓ Type of change

[x] 📖 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

attempting for #398

📝 Checklist

[x] I have linked an issue or discussion.
[x] I have updated the documentation accordingly.

RSS1102 commented 3 weeks ago

[x] stub : For stub, I attempted to add an explanation reference for antfu in README.md.(Perhaps a more detailed explanation of Watcher/JIT should be provided in the jiti repo) I raised a PR to Jiti https://github.com/unjs/jiti/pull/250. I see plans to support -- watch, should we explain the difference between these two in the documentation?
[x] inlineDependencies : Is it necessary to further elaborate on the usage instructions that have already been explained in it?( But he is indeed not in the rollup option). https://github.com/unjs/unbuild/blob/c878a37e738dea10080db41d5dcca0792fc45c8d/src/types.ts#L83
[ ] Mkdist dual format: should mkdist be changed to support this feature.Add a configuration, get:
```
-esm
/index.mjs
-cjs
/index.cjs
```
[x] Decorators
[x] Source map usage

RSS1102 commented 2 weeks ago

@pi0 😀😀This is my current progress, I have a few doubts. Do you have any opinions on this? How should I proceed with this PR next?

pi0 commented 2 weeks ago

Nice progress. I was not sure when your work would be ready to review if it is i can happily update to merge and iterate.

RSS1102 commented 2 weeks ago

Nice progress. I was not sure when your work would be ready to review if it is i can happily update to merge and iterate.

ok，This is what I can currently determine to be the right thing to do, and I believe you can review and determine what the next steps should be.（All the progress and questions are on the list above.）