Releases: inttter/create-ps
v4.4.3
β¨ Features
-
ef81964 β¨ feat: add 'create-ps' alias
Example
create-ps cool-new-package # The same as 'cps cool-new-package'
π§Ή Chores
- 20e18f9 π§Ή chore: do not allow already taken package name's on npm to be used
- If it returns a
200
response, then a package in the registry already has already taken that name, and thus is not available. - If it returns a
404
response, then a package with that name does not exist in the registry, meaning the name is available.
- If it returns a
π¦ Dependencies
- 85ff121 π¦ chore(package): bump axios from 1.7.2 to 1.7.3 (#13)
- 907c455 π¦ chore(package): bump axios from 1.7.3 to 1.7.4 (#14)
- a502fab π¦ chore(package): bump execa from 9.3.0 to 9.3.1 (#15)
Files and file contents fetched from Gist's remain unchanged in this release.
v4.4.2
β¨ Features
- 1a8b37d β¨ feat: allow already existing files to be skipped
- When you are warned of files being overwritten, you are asked if you want to skip the listed file paths.
- If you select
Yes
, the listed file paths won't be created, and the file paths that don't already exist will be created as normal. - If you select
No
, the file paths are overwritten as normal with template content.
β»οΈ Refactors
-
0e1fb42 β»οΈ refactor: handle invalid dependencies significantly better
Example
As an example, let's say you entered something like:
open, execa, invalidname12347489, chalk@4.0.0
In this case, while
open
,execa
andchalk@4.0.0
are valid, since they exist and the versions are valid,invalidname12347489
would be the invalid dependency, since it does not exist. The user will be notified which dependencies are invalid and asks them to re-enter the invalid dependencies correctly.
π§Ή Chores
- bc44ce8 π§Ή chore(pkg-config): make success message match main command
- 32a56ef π§Ή chore(pkg-config): improve warning of no funding type
Files and file contents fetched from Gist's remain unchanged in this release.
v4.4.1
v4.4.0
β»οΈ Refactors
-
db9ab10 β»οΈ refactor: overhaul the contents of multiple files
This includes includes a subset of changes:
-
β»οΈ refactor: fetch most long template files' contents from github gist's
- In short, the contents of these files are now fetched from a secret gist, holding the contents of these files. This means that new releases won't have to be made for any changes to these files anymore.
- With this, some of the content has been changed (see further below). However, any future changes to the content of these files will still be outlined within any future changelogs.
Updated files:
docs/example.md
- Expanded a bit more with better language..github/workflows/workflow.yml
- Added an extra comment, plus miniscule edits.CONTRIBUTING.md
- Completely revamped existing content with much more detail and better formatting.README.md
- See below for the changes to this file.
-
β»οΈ refactor(README.md): append extra content depending on
CONTRIBUTING.md
andLICENSE
inclusion- If the
CONTRIBUTING.md
toggles is selected, then some extra content about contributing to the package is appended to theREADME.md
file. - Same with if the
LICENSE
file toggle is selected, it will find the license name and display a short notice about the packages' license. README.md
is not affected by the change to storing file contents as Gists for most long files. See this comment for why.
- If the
-
β¨ Features
-
5fd5315 β¨ feat(workflows): include a full example of a workflow
- View the example workflow here.
-
e87b091 β¨ feat(prompts): allow cancellation using CTRL+C
- Meaning the prompt will exit the command when you press the key combination.
π§Ή Chores
-
2d09f16 π§Ή chore(license): automatically fill in
[year]
and[fullname]
fields[year]
is changed to the current year.[fullname]
is changed to the user's set Git username.
-
8bb1510 π§Ή chore: also check for existing directories
- Now also finds directories which already exist and display them in the warning message.
-
40b6368 π§Ή chore(cjs): improve warning message
π Documentation
- acf9658 π docs: update and clean up documentation
v4.3.0
π₯ Breaking
- ea08bce π₯ BREAKING: use ESM by default
--esm
has become--cjs
. ESM syntax is now used by default.- Behind the scenes, a lot more has been done to ensure there are no issues (especially when using ESM), such as adding
"type": "module"
and adding theengines
field with a minimum of Node.js 18. You can view the rest by clicking on the commit hash. - Most of this was taken from Sindre Sorhus' FAQ.
π§Ή Chores
- ea08bce π§Ή chore: warn if user uses
--cjs
- ea08bce π§Ή chore(esm): add
type
andengines
topackage.json
- 53931ad π§Ή chore: use node .gitignore template
π Documentation
- d3b1839 π docs: update documentation
π Bugfixes
-
81487b4 π fix(dependencies): remove versions from statements
Let's say you put
chalk@4.0.0
as one of the dependencies to install. Before, the statement would become:import chalk@4.0.0 from 'chalk@4.0.0'
orconst chalk@4.0.0 = require('chalk@4.0.0')
This is no longer the case. Anything after (and including) an
@
is removed, so the above would now become:import chalk from 'chalk'
orconst chalk = require('chalk')
Obviously, this doesn't eliminate the fact that packages
import
/require()
modules differently, however this will help in cases where people use a specific version of a dependency.
v4.2.0
β¨ Features
-
4e8516c β¨ feat: add dependency installation option
-
fea438e β¨ feat(dependencies): add
import
/require
statements to files after installing dependencies
Note
There's no way to tell exactly how the package is called (ie. with modules, if they use {} or not), so the dependency name (${dep}
) for the name for both parts. There are comments to warn you about this and recommend you to read the documentations for those packages.
π¦ Packages
- 1772bba π¦ chore(package): Bump execa from 9.1.0 to 9.2.0
v4.1.0
β¨ Features
- fd6ac1d β¨ feat(gitignore): use github node template for
.gitignore
file
β»οΈ Refactors
- 7708f0f β»οΈ refactor(funding): prompt to enter funding type and url
Note
If you don't specify a funding type, it will default to using the individual
type.
β Enter the funding type you want to use:
β github
β
β Enter the funding URL:
β https://github.com/sponsors/inttter
π§Ή Chores
- 07f676c π§Ή chore: adjust reccomended hints
π¦ Dependencies
- 572a79e π¦ chore(package): Bump axios from 1.7.1 to 1.7.2
v4.0.4
v4.0.3
β¨ Features
- 01fa883 β¨ feat(pkg-config): improve funding field
- Added funding types, prompting for funding type, and validation.
Note
The funding type prompt does not include every single type that can be used in a package.json, as there are quite a lot. If you want to link to an OpenCollective page for example, you can use "type": "opencollective"
, same with others like GitHub.
π§Ή Chores
- b160c01 π§Ή chore: add validation to urls in pkg-config
v4.0.2
π§Ή Chores
-
b5e6255 π§Ή chore: run
npm pkg fix
to formatrepository
field -
2700843 π§Ή chore: use clack 'outro' import for success messages
-
7686bce π§Ή chore: remove optional
directories
field in package.json
π¦ Dependencies
-
9a69d33 π¦ chore(package): Bump execa from 8.0.1 to 9.0.0
-
ec4ddd3 π¦ chore(package): Bump execa from 9.0.0 to 9.0.2
π Documentation
- ed11686 π docs: link to demo video