Skip to content

Feature: Make the plugin production-ready#1

Draft
dfdez wants to merge 1 commit intomasterfrom
feature/production-ready
Draft

Feature: Make the plugin production-ready#1
dfdez wants to merge 1 commit intomasterfrom
feature/production-ready

Conversation

@dfdez
Copy link
Copy Markdown
Owner

@dfdez dfdez commented Mar 9, 2026

Summary

This pull request transitions the repository from a minimal prototype into a production-ready, open-source-ready Prettier plugin.

Key Changes

  • Robust YAML Sorting: Improved src/index.js to handle nested mappings and more complex AST structures.
  • Testing Suite: Added a comprehensive Vitest testing suite in tests/index.test.js covering primary use cases.
  • Documentation: Created a detailed README.md with installation and usage instructions.
  • Project Configuration: Added .gitignore, .eslintrc.json, and .prettierrc to maintain high code quality and consistency.
  • Build Pipeline: Configured Rollup for automated CJS/ESM bundling via npm run build.
  • Package Metadata: Updated package.json with appropriate versioning, keywords, and peer dependencies.

Verification

  • Run npm install to install dependencies.
  • Run npm run test to execute the Vitest test suite.
  • Run npm run build to generate the production bundles in dist/.
  • Run npm run lint to check for code quality issues.

This commit includes:
- Improved YAML key sorting logic to handle nested mappings.
- Added comprehensive testing suite with Vitest.
- Standardized project configuration (ESLint, Prettier, .gitignore).
- Added README.md with usage instructions.
- Configured build pipeline with Rollup.
@dfdez dfdez marked this pull request as draft March 9, 2026 00:54
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.

1 participant