caffeine-addictt / template

A template for github repositories

Repository Template

Simple repository template to get started with GitHub.

Report Bug · Request Feature

About The Project

A simple repository template to get started with GitHub.

Starting a new project? Say goodbye to repetitive setup tasks and configuration headaches! Simplify your workflow, save time, and ensure consistency across projects.

Let's make starting new projects feel like a breeze again.

(back to top)

Getting Started

1. Creating a repository

Click the green "Use this template" button in the top right corner of the page or the button below to create your new repository.

2. Run the setup script

Note

Only Node.Js versions 16, 18, 20 and latest are officially supported.

Run the following command and answer the prompts to complete the setup.

node ./dist/setup.js

3. Final touches

You are almost ready to start building your project. Just a few more steps and you're ready to go!

• Update CITATION.cff file with your project information.
• Create and add project images to the images/ directory and update README.md file.
• Update LICENSE.txt file with your preferred license.
• Update .github/CODESTYLE.md with your project's preferred code style.
• Update CONTRIBUTING.md with your project's preferred contribution guidelines.
• Update the workflow files in the .github/workflows/ directory.

Note

We know that there is still a fair amount of manual setup required, and we are committed to making this process as smooth and painless as possible.

If you have any feedback, please feel free to create an issue or a pull request.

Want to support this project? ✨ Star it on GitHub and help us spread the word!

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. ( ˶ˆᗜˆ˵ )

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Read our contributing guide for more information.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alex - [email protected]

(back to top)

Acknowledgments

• Choose an Open Source License
• GitHub Emoji Cheat Sheet
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields

(back to top)

template's Issues

Streaming file content

Enhancement Request

Your issue may already be reported!
Please check out our active issues before creating one.

Is Your Enhancement Request Related to an Issue?

At present, we load all file contents into memory and do a singular RegExp match and replace operation.
Doing it this way is not optimal (not too impactful, but we strive to ship good software c;);

• Will require more memory
• Will impact runtime performance

Describe the Solution You'd Like

File streaming.

Instead of loading the file contents into memory, we can just;

1. stream each line of the file into memory
2. format the line with the same RegExp
3. stream the formatted line into a generated file in a generated temp directory
4. then replace the original file with the formatted file

Note

I have already tried to implement this, albeit unsuccessfully.
You can find my unsuccessful code highlighted here.

Additional Context

PRs welcome!

[Bug] Use -f on development-only files

Adding the -f or the force: true to cleanup for development dependencies as if they do not exist, they will throw.

[Feature] Configure assignees

There should be an option to specify multiple issue template assignee's.

[Bug] {{REPOSITORY}} is overrided with the repository and not the <org>/<repo>

Updating CONTRIBUTING.md

To add/update

• Linting
• Building
• PR
• Testing

[Bug] Broken license link

DO NOT MERGE label

A DO NOT MERGE label

Platform compatibility

The setup script was developed for and on Linux.

Might not be compatible with other OSes. PRs welcome.

Spec

• Porting bash to node

[Feature] Validating input

Inputs should be verified.

For example, entering a non-email when asked to provide an email should throw.

Ability to specify license

Perhaps we could have an option to specify the license type.

Note

If you'd like to contribute to this feature, please use v1.14 as your base branch

Spec

Perhaps something like this:

License type [MIT, BSD-3, ..., None]
=> 

The template/ file structure and code would likely have to be updated to something like this:

root/
|_ template/
|  |_ project/
|  |  |_ ...
|  |_ licenses/
|      |_ MIT.md
|_ ...

Acceptance

• Texts specifying the license type should be dynamic (eg. README)

Update CI to only use linting with prettier

Enhancement Request

Your issue may already be reported!
Please check out our active issues before creating one.

• Add prettier with npm
• Add prettier CI
• Delete prettier artifacts with setup script

Testing for Linux, Windows and Darwin

Testing for the 3 major OSes (Linux, Windows & Darwin).
PR welcome

Track

• PR #30
• Issue #23
• Waiting on #28
• Waiting on #33
• Merging after #29

[Bug] File content not being replaced

Bug report

Your issue may already be reported!
Please check out our active issues before creating one.

Description

The file content with {{NAME}} for example, should be replaced with the name inputted, however, it is left as {{NAME}}.

Is this a regression?

Yes

Possible Solution

Steps to Reproduce (for bugs)

Context

Your Environment

• Version used:
• Operating System and version (desktop or mobile):

Automatically resolve git details

[Bug] Incorrect replacement for assignees

Bug report

Your issue may already be reported!
Please check out our active issues before creating one.

Expected Behavior

"assignees: caffeine-addictt" should be replaced with "assignees: "

Current Behavior

"assignees: caffeine-addictt" is replaced with ""

Is this a regression?

No.

Possible Solution

Steps to Reproduce (for bugs)

Context

Your Environment

• Version used:
• Operating System and version (desktop or mobile):

Typescript

I'm thinking we develop setup with typescript, then build it to Js.
This can prevent any type errors and reduce runtime error overhead.

Users will be executing setup with node dist/setup.js.