wormiecorp / generator-cake-addin Goto Github PK
View Code? Open in Web Editor NEWA yeoman generator to get you quickly set up for writing Cake Addins
License: GNU General Public License v3.0
A yeoman generator to get you quickly set up for writing Cake Addins
License: GNU General Public License v3.0
This could perhaps come under the documentation generator, or the config generator (unsure currently)
Dependabot couldn't find a .(cs|vb|fs)proj for this project.
Dependabot requires a .(cs|vb|fs)proj to evaluate your project's current .NET dependencies. It had expected to find one at the path: /src/project/templates/<anything>.(cs|vb|fs)proj
.
If this isn't a .NET project, or if it is a library, you may wish to disable updates for it from within Dependabot.
You can mention @dependabot in the comments below to contact the Dependabot team.
Is your feature request related to a problem? Please describe.
Currently, the project generator only generates a unit testing library using xunit. While this may be used by most people creating a new addin, there should be the ability to change it.
Describe the solution you'd like
A selection of different unit testing libraries that can be used when generating the unit testing library. At a minimum, nunit tests should also be allowed to be selected.
Describe the bug
all-contributors-badge does not update automatically in a generated README.md when using all-contributors (bot or cli)
To Reproduce
Steps to reproduce the behavior:
Expected behavior
The all-contributors badge should be updated.
Additional context
The problem seems to be missing star- and end-tags. See https://allcontributors.org/docs/en/bot/faq
(However, adding those seems to break the flow of badges..)
There are some major breaking changes in Cake.Recipe 2.0.0, so updating the generator to support these changes will most likely be quite the undertaking.
This will be considered a quite heavy breaking change in the generator as well.
Is your feature request related to a problem? Please describe.
The project files currently do not include a file header even
for licenses that recommends adding one.
Describe the solution you'd like
The project files in C# should also include a license header
if the selected license recommends adding one, if one is not
recommended, a stylecop configuration file should be created
that disables the warning about a missing file header.
Describe alternatives you've considered
Additional context
This generator should create the following files.
.sln
).csproj
file (with metadata for packaging).csproj
fileThis generator should create a code of conduct file, a Readme file based on standard-readme, a license file, and optionally a contributing file.
It will be split into several generators, with a docs generator calling all of them.
Describe the bug
When the generator is running on windows, there are times (unsure if every time or not) that you will need to press enter when you are about to select the unit testing framework to use, before you are allowed to select the one you want.
To Reproduce
Steps to reproduce the behavior:
yo cake-addin
Which unit testing library do you want to use for the cake addin?
{Enter}
Expected behavior
Expects to be able to choose the unit testing library to use without first pressing {Enter}
Desktop (please complete the following information):
Additional context
This is believed to be related to the known issue listed in the Readme.md
.
I have pretty much never written a unit test for any javascript/typescript library in my life, so I would love to have some help on this one if anyone is up for it.
Dependabot couldn't find a .(cs|vb|fs)proj for this project.
Dependabot requires a .(cs|vb|fs)proj to evaluate your project's current .NET dependencies. It had expected to find one at the path: /<anything>.(cs|vb|fs)proj
.
If this isn't a .NET project, or if it is a library, you may wish to disable updates for it from within Dependabot.
You can mention @dependabot in the comments below to contact the Dependabot team.
Dependabot couldn't find a .(cs|vb|fs)proj for this project.
Dependabot requires a .(cs|vb|fs)proj to evaluate your project's current .NET dependencies. It had expected to find one at the path: /<anything>.(cs|vb|fs)proj
.
If this isn't a .NET project, or if it is a library, you may wish to disable updates for it from within Dependabot.
You can mention @dependabot in the comments below to contact the Dependabot team.
This generator should create the following files:
When running yo cake-addin
, the output after inputting all the values is:
Error cake-addin
generator.run is not a function
yo
(5.0.0)The addin scaffolding should be created.
- **OS**: win 11
- **Project Version**: 1.6.0
>21:48:36 ❯ yo cake-addin
_-----_ ╭──────────────────────────╮
| | │ Welcome to the │
|--(o)--| │ cake-addin generator. We │
`---------´ │ will now ask you some │
( _´U`_ ) │ questions so we can set │
/___A___\ /│ up your new Cake addin │
| ~ | │ project! │
__'.___.'__ ╰──────────────────────────╯
´ ` |° ´ Y `
? What is the name of the Cake addin project? test-1
? Who is the repository owner/organization where the addin will located? nils
? What is the github username of the main addin author? nils
? What is the the name of Cake addin author? Nils Andresen
? What is the description for the Cake addin? Received
? What license will the Cake addin use? MIT
? Where will the project source files be located? ./src
? What is the name of the cake build script to use? recipe.cake
? Do you want to add configurations for the All Contributors Bot? No
? Do you want to use Wyam to generate documentation? Yes
? Do you wish to enable travis builds? No
? Do you wish to use tabs for indentation? No
? What indent size do you wish to use (amount of spaces)? 4
? What indent size do you wish to use for yml/yaml files (amount of spaces)? 2
? Do you wish to use a CONTRIBUTING.md file? No
Error cake-addin
generator.run is not a function
No response
Is your feature request related to a problem? Please describe.
The license generator currently blindly outputs the license to a filename to LICENSE.txt
, unless overridden with the out
option.
Describe the solution you'd like
The generator test for possibly other names, and if one of the other names exist, it should output the license to that file.
possible name:
LICENSE
LICENSE.txt
LICENSE.md
COPYING
COPYING.txt
COPYING.md
Describe alternatives you've considered
While it can be overridden with the out parameter, this should not be needed when there is already a license file available.
Describe the bug
The project generator is currently creating the runner tests class with the name ProjectNameTests
.
Expected behavior
The generator should create the template class with the following class name ProjectNameRunnerTests
.
This question is indented to be the full name of the main project author (although, the user may decide to use its username instead), this is not reflected as is indented when the question is asked.
Dependabot couldn't find a .(cs|vb|fs)proj for this project.
Dependabot requires a .(cs|vb|fs)proj to evaluate your project's current .NET dependencies. It had expected to find one at the path: /<anything>.(cs|vb|fs)proj
.
If this isn't a .NET project, or if it is a library, you may wish to disable updates for it from within Dependabot.
You can mention @dependabot in the comments below to contact the Dependabot team.
I'm not sure whether this is really a bug in the generator or rather a problem in the windows defaults of git, but:
The generator generates .gitattributes
with content:
###############################################################################
# Set default behavior to automatically normalize line endings.
###############################################################################
* text=auto
*.cs text diff=csharp
*.ps1 text eol=crlf
*.bat text eol=crlf
*.sln text eol=crlf
*.csproj text eol=crlf
tasks.json text eol=crlf
*.sh text eol=lf
*.md text whitespace=-trailing-space
# Exclude files from exporting
.gitattributes export-ignore
.gitignore export-ignore
This leads to csproj being converted to crlf
during checkout on non-windows systems (actually on windows-systems, too but here that's the default...)
At the same time, during checkin on windows (or rather on systems with core.autocrlf=true
) those line-endings will be converted to lf
,
Now, the problem starts when development is done on windows and linux (or on windows and having dependabot create PRs): While windows-systems will always checkin lf
line-endings, the non-windows-systems will checkin crlf
line-endings.
To demonstrate I have created a simple repository and let dependabot make PRs:
*.csproj text eol=crlf
set in .gitattributes
:
While I do see that this is also (maybe more so) the fault of the windows-default of setting core.autocrlf=true
, may I ask: Is there a reason for setting eol=crlf
? It does nothing on windows-systems and while it converts the files during checkout on non-windows-systems the files shuold have been created correctly in the first place. Or am I missing something?
Describe the bug
Seems like I have been making some mistakes when creating the the last two (at least) releases, and the package do not include any generator at all.
This was missed during testing because I had the generator linked.
Mix this with my inexperience with node and npm, and this is what we got XD
/cc @gep13
Due to an unknown problem with the unit tests are hanging on appveyor windows builds, this image have been disabled on the ci cloud server.
This unit tests still works on a local windows installation, just not on appveyor.
Any help in resolving this issue would be greatly appreciated.
Describe the bug
The original code of conduct file expects an email address to contact when a breach of the conduct has happened. However, there is no prompt or replacement done to get this email address.
To Reproduce
Steps to reproduce the behavior:
yo cake-addin:conduct
CODE_OF_CONDUCT.md
file[INSERT_EMAIL_ADDRESS]
(or similar)Expected behavior
Would expect to be prompted to input an email address
Desktop (please complete the following information):
This generator should be able to create the following files.
All Contributors bot
(Optional)Describe the bug
During the the running of the generator the following is being outputted to the user:
enableAllContributors is of type string before adding prompts with value true
enableAllContributors is of type string before calling prompts with value true
enableAllContributors is of type boolean after calling prompts with value true
Logging values in allValues
THese are not needed to be outputted.
To Reproduce
Steps to reproduce the behavior:
yo cake-addin
Expected behavior
Those lines should not be logged to the user
Desktop (please complete the following information):
Describe the bug
When a GitReleaseManager yml file is generated it generates it with an incorrectly named key.
To Reproduce
Steps to reproduce the behavior:
GitReleaseManager.yml
file.Expected behavior
I expects it to generate a create.footer-includes-milestones
key, it is missing the s in includes though.
Desktop (please complete the following information):
Describe the bug
When prompted for a short description, this should be required when the main description is over 120 characters. The short description allows continuing if the input is empty.
Expected behavior
A validation message should be outputted to the user.
Desktop (please complete the following information):
Describe the bug
The generator creates the git release manager config file with the wrong file name. It is currently being created with the name GitReleaseManager.yml
To Reproduce
Steps to reproduce the behavior:
yo cake-addin:config
Expected behavior
SHould use the correct file name GitReleaseManager.yaml
Desktop (please complete the following information):
it should be Environment.SetEnvironmentVariables
instead of Environment.SetVariableName
Is your feature request related to a problem? Please describe.
Currently the readme generator links to a license named LICENSE.txt
no matter what it is called in the repository.
Describe the solution you'd like
The readme generator should check for commonly used license names, and select the name of the existing license to link to.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.