diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index bba6ddf..da9e0f0 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,2 +1 @@ -github: wessberg patreon: wessberg diff --git a/CHANGELOG.md b/CHANGELOG.md index b4388f5..dc5567c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,12 @@ +# [3.0.0](https://github.com/wessberg/sandhog/compare/v2.0.2...v3.0.0) (2024-10-10) + + +### Features + +* migrate to Node 22 ([ddcb7fe](https://github.com/wessberg/sandhog/commit/ddcb7fe84def1dd721c30851ef2b86794291cd2b)) + + + ## [2.0.2](https://github.com/wessberg/sandhog/compare/v2.0.1...v2.0.2) (2022-05-31) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index df948d7..3c7cf7d 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting any of the code of conduct enforcers: [Frederik Wessberg](mailto:frederikwessberg@hotmail.com) ([@FredWessberg](https://twitter.com/FredWessberg)) ([Website](https://github.com/wessberg)). +reported by contacting any of the code of conduct enforcers: . All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8fda39..35e171f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,9 @@ -You are more than welcome to contribute to `sandhog` in any way you please, including: +You are more than welcome to contribute to `undefined` in any way you please, including: - Updating documentation. - Fixing spelling and grammar - Adding tests - Fixing issues and suggesting new features -- Blogging, tweeting, and creating tutorials about `sandhog` -- Reaching out to [@FredWessberg](https://twitter.com/FredWessberg) on Twitter +- Blogging, tweeting, and creating tutorials about `undefined` + - Submit an issue or a Pull Request diff --git a/LICENSE.md b/LICENSE.md index 8bd2556..a8333f1 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright © 2022 [Frederik Wessberg](mailto:frederikwessberg@hotmail.com) ([@FredWessberg](https://twitter.com/FredWessberg)) ([Website](https://github.com/wessberg)) +Copyright © 2024 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index de1613c..e9f979a 100644 --- a/README.md +++ b/README.md @@ -58,12 +58,6 @@ Sandhog works out of the box without any configuration. Some highlights include: ## Backers -[Become a sponsor/backer](https://github.com/wessberg/sandhog?sponsor=1) and get your logo listed here. - -| Bubbles | Christopher Blanchard | Ideal Postcodes | Xerox | Trent Raymond | scrubtheweb | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| [Bubbles](https://usebubbles.com)
Twitter: [@usebubbles](https://twitter.com/usebubbles) | [Christopher Blanchard](https://github.com/cblanc) | [Ideal Postcodes](https://github.com/ideal-postcodes) | [Xerox](https://www.xerox.com) | [Trent Raymond](https://changelog.me) | [scrubtheweb](https://scrubtheweb.com) | - ### Patreon Patrons on Patreon @@ -113,7 +107,6 @@ Sandhog works out of the box without any configuration. Some highlights include: - [`backers`](#backers) - [`license`](#license) - [Contributing](#contributing) -- [Maintainers](#maintainers) - [FAQ](#faq) - [Do you support custom templates?](#do-you-support-custom-templates) - [How do you determine the Code Style of the project?](#how-do-you-determine-the-code-style-of-the-project) @@ -179,83 +172,83 @@ Sandhog is highly configurable. You can provide a configuration in a variety of ```typescript interface SandhogOptions { - // If true, the install directions inside generated READMEs will suggest installing this package as a development dependency. - isDevelopmentPackage: boolean; - // If provided, a logo image will be placed in the top of generated or updated README files - logo: { - // An URL to the logo. - url: string; - // The height of the logo in pixels - height: number; - }; - - // If provided, a feature image will be placed within generated or updated README files - featureImage: { - // An URL to the feature image. - url: string; - // The height of the feature image in pixels - height: number; - }; - // If Patreon, Open Collective, and/or other donation options is given, badges and backer/sponsor shields will be generated and added to generated or updated README files. - donate: { - patreon: { - userId: string; - }; - openCollective: { - project: string; - }; - other: { - fundingUrl: string; - donors: [ - { - name: string; - url: string; - imageUrl: string; - twitter: string; - } - ]; - }; - }; - readme: { - badges: { - // The given iterable of SectionKinds will never be added to generated or updated READMEs - // Can be any of the following: 'toc', 'logo', 'badges', 'description_short', 'description_long', 'features', 'feature_image', 'usage', 'install', 'contributing', 'maintainers', 'faq', 'backers', and 'license' - exclude: Iterable< - | "toc" - | "logo" - | "badges" - | "description_short" - | "description_long" - | "features" - | "feature_image" - | "usage" - | "install" - | "contributing" - | "maintainers" - | "faq" - | "backers" - | "license" - >; - }; - sections: { - // The given iterable of BadgeKinds will never be added to generated or updated READMEs. - // Can be any of the following: 'downloads', 'dependencies', 'npm', 'contributors', 'license', 'patreon', 'open_collective_donate', 'open_collective_backers', 'open_collective_sponsors', and 'code_style' - exclude: Iterable< - | "downloads" - | "dependencies" - | "npm" - | "contributors" - | "license" - | "patreon" - | "open_collective_donate" - | "open_collective_backers" - | "open_collective_sponsors" - | "code_style" - >; - }; - }; - // By default, Sandhog will try to locate a Prettier config within the project. You can also just provide it or override the Prettier options here - prettier: PrettierOptions; + // If true, the install directions inside generated READMEs will suggest installing this package as a development dependency. + isDevelopmentPackage: boolean; + // If provided, a logo image will be placed in the top of generated or updated README files + logo: { + // An URL to the logo. + url: string; + // The height of the logo in pixels + height: number; + }; + + // If provided, a feature image will be placed within generated or updated README files + featureImage: { + // An URL to the feature image. + url: string; + // The height of the feature image in pixels + height: number; + }; + // If Patreon, Open Collective, and/or other donation options is given, badges and backer/sponsor shields will be generated and added to generated or updated README files. + donate: { + patreon: { + userId: string; + }; + openCollective: { + project: string; + }; + other: { + fundingUrl: string; + donors: [ + { + name: string; + url: string; + imageUrl: string; + twitter: string; + } + ]; + }; + }; + readme: { + badges: { + // The given iterable of SectionKinds will never be added to generated or updated READMEs + // Can be any of the following: 'toc', 'logo', 'badges', 'description_short', 'description_long', 'features', 'feature_image', 'usage', 'install', 'contributing', 'maintainers', 'faq', 'backers', and 'license' + exclude: Iterable< + | "toc" + | "logo" + | "badges" + | "description_short" + | "description_long" + | "features" + | "feature_image" + | "usage" + | "install" + | "contributing" + | "maintainers" + | "faq" + | "backers" + | "license" + >; + }; + sections: { + // The given iterable of BadgeKinds will never be added to generated or updated READMEs. + // Can be any of the following: 'downloads', 'dependencies', 'npm', 'contributors', 'license', 'patreon', 'open_collective_donate', 'open_collective_backers', 'open_collective_sponsors', and 'code_style' + exclude: Iterable< + | "downloads" + | "dependencies" + | "npm" + | "contributors" + | "license" + | "patreon" + | "open_collective_donate" + | "open_collective_backers" + | "open_collective_sponsors" + | "code_style" + >; + }; + }; + // By default, Sandhog will try to locate a Prettier config within the project. You can also just provide it or override the Prettier options here + prettier: PrettierOptions; } ``` @@ -270,19 +263,19 @@ For example: ```json5 // Inside package.json { - contributors: [ - { - name: "John Done", - email: "john@doe.com", - url: "https://john.doe", - - // The following three fields are enhancements - imageUrl: "https://john.doe/avatar.png", - role: "Lead Developer", - twitter: "JohnDoe", - github: "johndoe" - } - ] + contributors: [ + { + name: "John Done", + email: "john@doe.com", + url: "https://john.doe", + + // The following three fields are enhancements + imageUrl: "https://john.doe/avatar.png", + role: "Lead Developer", + twitter: "JohnDoe", + github: "johndoe" + } + ] } ``` @@ -569,12 +562,6 @@ Do you want to contribute? Awesome! Please follow [these recommendations](./CONT -## Maintainers - -| Frederik Wessberg | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Frederik Wessberg](mailto:frederikwessberg@hotmail.com)
Twitter: [@FredWessberg](https://twitter.com/FredWessberg)
Github: [@wessberg](https://github.com/wessberg)
_Lead Developer_ | - @@ -600,6 +587,6 @@ By looking for several things, including: ## License -MIT © [Frederik Wessberg](mailto:frederikwessberg@hotmail.com) ([@FredWessberg](https://twitter.com/FredWessberg)) ([Website](https://github.com/wessberg)) +MIT © diff --git a/package.json b/package.json index 8045cc1..bcc32fb 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sandhog", - "version": "2.0.2", + "version": "3.0.0", "bin": { "sandhog": "bin/sandhog.js" },