- Two gifs were slowing down the page too much: Removed the old gif from the README since the new gif is good enough
- Fixed README & Comments: The readme is now more comperhensive, Added more examples and guides, Added production guide, Improved code structure and tsconfig
- Fixed Wrong CD Path: The CD path shown at the end of the new project creation was showing the project name instead of the folder name
- OS File Name Error Fixed: When creating the workspace file the name can not contain slashes, it was replaced with a plus
- Deno is supported: Deno support for newly created projects now works smoothly even with nodemon and the hotreload
- The slash in the project name can not be used as a folder name: Replaced the slash with a plus as seen in .deno node modules
- Critical Fixes: Deno project names will now enforce the use of at sign according to the official regex pattern and critical arguments will now work properly
- Deno is almost compatible: The new Deno 2 runtime is almost ready to be used with Supe Project Builder, Added missing info in the help menu about the new runtime CLI option, and completely rewrote the start.ts file for Deno and the hotreload/server.ts for Deno (Applies to newly generated projects)
- Last improvements to the README: The readme key features was improved to better reflect what SCP is all about, Upcoming: V2!
- Readme is now readable: Finished upgrading the readme, now finally testing the final generated project on both deno and bun, Bun already worked before, And later maybe even node will work.
- Reorganized VSCode Workspace, Improved Readme, Simplified Comments: Some comments were made simple, The readme file readability was improved, and the VSCode workspace now contain all the new files
- Deno Bug: When you run the deno jsr: command it uses a cached version even if many newer versions were launched, to fix it I specify the version inside the installation
- Added Links & New Technical Detail: New links to the changelog, roadmap, contributing, license and code of conduct were added, also rephrased some of the sentences to better reflect what it does
- Specify the runtime via the CLI: Support for deno is almost complete
- Ops: Removed the example project pushed in the last version
- Preparing for v2: The runtime variable was replaced with CLI options
- Refactor Documentation and Introduce Mandatory Runtime Option: The
runtime
variable is no longer optional and must be provided now, The change log was moved toCHANGELOG.md
, The contributors guidelines were moved toCONTRIBUTING.md
, The road map was moved toROADMAP.md
, README improvements
- No more outdated versions: The
deno run jsr:
command was using the old version you have cached and there is no@latest
flag so thebump.ts
script will now take care of this
- This patch addresses key issues and improves the development experience with enhanced documentation and configuration management: Fixed "require is not defined", migrated to
deno.json
, improved JSDocs, removed runtime detection, and resolved Deno version bump issue.
- README Adjustments: The fact you can also have a clean project was not clear enough, I added hints in the README to indicate that the AI Demo, as the name suggest, is optional.
- Generated projects now support deno: The generated projects use to only support bun, after a lot of hard work I'm approaching the final stages in implementing Deno into the project, this time I fixed the generated start.ts file in new projects created with Deno, Completing the loop required to run SCP on Deno, This still needs to be tested carefully so for now please use bun.
- Improved Section Layout: Reorganized existing sections in the README to enhance structure and readability
- Navigation Issue Resolved: Corrected a bug in JSR document navigation that misread sections inside Tips, ensuring users can accurately navigate to all relevant sections.
- Section Order Updated: Moved the Programmatic Usage section above the Contribution section in the README for better logical flow and accessibility, making it easier for users to find relevant information.
- Enhanced Clarity: Made adjustments throughout the README to improve readability and flow, ensuring that information is presented more clearly for users.
- Typographical Error Corrected: Addressed and corrected a typo in the README for improved clarity and professionalism.
- Enhanced Documentation: Revised the Key Features section to improve clarity and detail. Combined points on performance and intelligent workflow, and introduced a dedicated point for hot reloading.
- README Changes: Moved the new Programmatic Use section above the change log
- Updated README to clarify the
runtime
parameter and Deno importing instructions: Provided a detailed description of theruntime
parameter options
- Revised README to include a dedicated tip for using the recommended VSCode workspace file: Transformed the VSCode workspace configuration section into a clear tip, emphasizing its benefits for enhancing development experience and streamlining project management by excluding unnecessary files.
- Updated project creator tool with improved Deno compatibility, TypeScript support, and recommended VSCode extensions: Enhanced project creation with better support for Deno project naming, improved handling of deno.json and package.json, plus fixed bugs for a smoother experience.
- Enhanced README for better clarity and guidance: README updated with clearer instructions and examples.
- Enhanced the README for clearer guidance and better user experience.: The README has been improved with clearer instructions and detailed explanations to help users better understand how to use Supe Project Creator.
- Added basic Deno support, improved JSDoc documentation, and resolved linting issues in generated projects: Supe Project Creator now supports Deno alongside Node.js and Bun. JSDoc documentation has been enhanced, including the addition of a new
runtime
variable. Linting issues in the generated Deno and Bun projects have also been fixed, ensuring cleaner, error-free code.
- Improved README, and introduced a tests.ts script for testing.: The README has been updated for clearer guidance.
- Supe Project Creator now requires a project name to run and includes Deno types: Running the tool without a project name triggers the help message, and the project is now set up for Deno compatibility.
- Added project name validation and clear setup instructions: Supe Project Creator now validates project names and provides colored console logs for guidance.
- Enhanced README: The README file was carefully reviewed and everything is now almost perfect
- Improved Experience: The project now have a new VSCode Workspace that hides all the unnecessary files from the view
- New README Screenshots and GIF: Who doesn't like screenshots and GIFs, added some preview screenshots hosted in my profile repo (not on JSR)
- Improved Version Bumper: Added colors to console logs and optimized the algorithm
- New Rules: It is important that new contributors read the code of conduct if they plan to contribute
- Fixed Incorrect Answer Crashes the Version Bumper: The version bumper will not crash anymore when inputting an incorrect answer (y/n)
- Smarter Questions: Questions in the version bumper will now properly handle mistakes
- Accurate project description: The project description has changed from "powerful" to "simple" to better reflect what the project is about and remove "we" from the README
- Fixed error no-unused-vars: When using
deno lint
the project will be checked for TypeScript issues, Removing this unused variable was the last error to fix in both typescript files, note thatindex.ts
is the main package used to create projects andbump.ts
is a contributor only script to bump version in multiple files and then push to GitHub which will trigger the action to push into JSR. Good Job!
- Better Version Bump: The version bumper new feature to push into GitHub was tested and will now operate as intented, Also added detailed from/to version logs
- Version Control Support for the Bump Script: When
deno run bump
is used the script will prompt to push into GitHub at the end, but if there are any pending changes it will ask you if you want to pull them first and let you know if there were conflicts while pushing, Otherwise it will use the bump message to commit a detailed commit into GitHub
- Moved JSDocs: The docs were moved to the correct place and should appear properly now on JSR
- First Docs: Added an extensive JSDocs for the main package function
- Deno Lint and Default Export: Fixed linting issues and added support for packages and cli at the same time
- Fixed Project Setup: ESBuild was causing an unexpected issue when running for the first time, Notes were added.
- Better Instructions: A well-structured README file provides users with easy-to-follow instructions, reducing the likelihood of confusion, frustration, and support requests.
- Improved readability and documentation: Refactored README for better structure, added clear section headings, and reorganized content for easier navigation.
- Simplify usage and documentation: Replaced lengthy command with concise alternative and revamped readme for enhanced user experience and clarity.
- Enhanced version bumping system: Implemented a user-interactive auto bump system that requests confirmation before bumping the minor or major version. Added feature to input brief and secondary descriptions of changes for the README.md file.
- Added Version Bump Script: Implemented a simple script to streamline version bumping across multiple files, improving development efficiency.
- Preparing for the Future: Added more planned features for upcoming versions to enhance the project's roadmap.
- Resolved GitHub Programming Language Misidentification: Addressed an issue where GitHub falsely detected the project as 100% JavaScript due to the initial lines of code lacking TypeScript definitions. This was resolved by renaming
index.ts
and modifying the code to include TypeScript types within the first seven lines, ensuring accurate language detection.
- NPX Execution Preparation: Preparing the package for seamless execution via NPX, Added a
bin
value in thepackage.json
file.
- Added Informative Notes: Included detailed notes to enhance user understanding and improve overall documentation quality.
- NPX Execution Preparation: Made necessary adjustments to prepare the package for seamless execution via NPX, enhancing usability and accessibility.
- Corrected Typos: Identified and corrected minor typos.
- README Refinements: Implemented additional polish to the README, ensuring clarity and concision in its content.
- Corrected Typos: Identified and corrected minor typographical errors throughout the README to maintain a professional tone and presentation.
- Refined README Overview: Improved the readability of the README's overview section by clarifying key points and ensuring grammatical accuracy.
- Improved Overview Readability: Enhanced the grammar and clarity of the overview section in the README with accurate information.
- Project Navigation: Added instructions for users to navigate to the newly created project directory before running the installation and development commands, ensuring they operate within the correct context.
- Lines Removed: Removed trailing lines from the README.
- Improved Changelog Readability: Enhanced the grammar and clarity of the changelog section in the README for easier understanding.
- Detailed Features: Added comprehensive descriptions for all key features, giving a more detailed overview of each.
- Automation Boost: Introduced GitHub Actions to automate the build and improve the JSR score through enhanced provenance tracking.
- Up-to-Date Information: Refined the README by adding accurate and up-to-date descriptions of the tool's core features.
- Typo Fixes: Addressed minor typos in the README, ensuring the documentation reads more smoothly.
- Improved Installation: Introduced an additional argument to the installation instructions to guarantee timely updates of the tool.
- Resolved Path Issues: Fixed a bug related to the relative path in
package.json
creation for newly generated projects.
- Subfolder Bug Fix: Corrected an error that occurred when using a custom absolute path, ensuring subfolders are created correctly.
- Bug Squashing: Fixed the 'ENOENT: No such file or directory' error that occurred when creating new projects with custom absolute paths.
- Learning Milestone: Finished understanding JSR and applied it to finalize the README structure.
- Cleaned Up Documentation: Addressed small typos to make the README file more professional and readable.
- Batteries Included: Improved the README by triple-checking installation steps and adding a clearer "batteries-included" description.
- User-Friendly Commands: Streamlined the usage instructions by reducing the length of the command, making it easier to run.
- Cross-Runtime Support: Updated the README to better reflect the cross-runtime nature of JSR, ensuring compatibility across environments.
- Initial Configuration: Made the package globally compatible by adding the essential initial configurations to the
package.json
file.
- Community Standards: Outlined clear guidelines for contributing, including code style, commit messages, and PR labeling for better project collaboration.
- Expanded Details: Enhanced the documentation to better inform contributors and new users on how to get started and contribute to the project.
- Comprehensive Overview: Expanded the README file to provide a thorough overview of the project's goals and features.
- Project Documentation: Created the initial README to provide basic information about the project for users and contributors.
Initial Release
Note: Since this is the first version of the changelog, there are no previous versions to report on. Future updates will include detailed information about changes, bug fixes, and new features.