📝 Documentation: Not really documentation; rather feedback on using the latest and greatest

[johnnyreilly]

Bug Report Checklist

• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Overview

When using this, I didn't know what this meant:

✔ Whether to skip calling the GitHub API (effectively making this a local-only change). · no

I still don't! What does it mean?

The generated project still seems to be not completely initialised. Consider the package.json:

	"author": "Josh Goldberg <[email protected]>",

Likewise, the contributors lists Josh Goldberg and not me.

Additional Info

Happy to provide more in depth details

[johnnyreilly]

The .all-contributorsrc is similarly not really updated:

{
  "badgeTemplate": "<img alt=\"All Contributors: <%= contributors.length %>\" src=\"https://img.shields.io/badge/all_contributors-<%= contributors.length %>-21bb42.svg\" />",
  "commit": false,
  "commitConvention": "angular",
  "contributors": [
    {
      "avatar_url": "https://avatars.githubusercontent.com/u/3335181?v=4",
      "contributions": ["tool"],
      "login": "JoshuaKGoldberg",
      "name": "Josh Goldberg",
      "profile": "http://www.joshuakgoldberg.com"
    }
  ],
  "contributorsPerLine": 7,
  "files": ["README.md"],
  "imageSize": 100,
  "projectName": "template-typescript-node-package",
  "projectOwner": "JoshuaKGoldberg",
  "repoHost": "https://github.com",
  "repoType": "github",
  "skipCi": true
}

BTW, as friendly as they are, I'm not in love with the contributors functionality; I find it quite noisy. Might be nice to opt out entirely. Possibly personal preference.

[JoshuaKGoldberg]

This is great feedback, thanks @johnnyreilly. I'll file out individual issues. Keep it coming! 😄

When using this, I didn't know what this meant:
✔ Whether to skip calling the GitHub API (effectively making this a local-only change). · no

Yeah, that's not a great explanation. I'd added --skip-api so that when testing the setup script (e.g. in an actual end-to-end test for it, #146), there's a way to stop it from making API requests that change the repository. But you as an end user would basically never use that flag.

The generated project still seems to be not completely initialised. Consider the package.json:

Feels like a mixture of bug and feature request. It should ideally replace that author with the GitHub auth of whoever is running the script. Maybe even the end-to-end test script should verify that the string josh is nowhere in the repository after switching to test values...

Likewise, the contributors lists Josh Goldberg and not me.
...
The .all-contributorsrc is similarly not really updated:

I am slightly egotistically keeping myself in that list for "tool" because hey, it's my tooling that set up the package! But similar to the author portion, agreed, you the setup user should be added to it.

Might be nice to opt out entirely.

Heh, yeah. I can see it being especially noisy if used in single-person personal projects or even closed source projects... I'm personally not motivated to add the requisite logic to be able to turn different areas of integration on or off. But if you have ideas, I'd be up for receiving an issue and ponder some more.

---

Btw, @allcontributors add @johnnyreilly for bug, ideas, promotion. I'm trying to get better at remembering to do this - these all should have been done a while ago. 😄

[JoshuaKGoldberg]

@allcontributors add @johnnyreilly for bug, ideas, promotion.

[allcontributors]

@JoshuaKGoldberg

I've put up a pull request to add @johnnyreilly! 🎉

[johnnyreilly]

I need to discover what @allcontributors is! But not right now. Another one: the initialised README is also kind of incomplete; still lists the template repo stuff / old contributors etc

<h1 align="center">Remark Cloudinary Docusaurus plugin</h1>

<p align="center">Cloudinary offers an image CDN which can improve performance of your site. This plugin allows Docusaurus to use Cloudinary to serve optimised images.</p>

<p align="center">
	<a href="#contributors" target="_blank">
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<img alt="All Contributors: 4" src="https://img.shields.io/badge/all_contributors-4-21bb42.svg" />
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->
	</a>
	<a href="https://codecov.io/gh/johnnyreilly/remark-cloudinary-docusaurus" target="_blank">
		<img alt="Codecov Test Coverage" src="https://codecov.io/gh/JoshuaKGoldberg/template-typescript-node-package/branch/main/graph/badge.svg?token=eVIFY4MhfQ"/>
	</a>
	<a href="https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank">
		<img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" />
	</a>
	<a href="https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/LICENSE.md" target="_blank">
	    <img alt="License: MIT" src="https://img.shields.io/github/license/JoshuaKGoldberg/template-typescript-node-package?color=21bb42">
    </a>
	<a href="https://github.com/sponsors/JoshuaKGoldberg" target="_blank">
    	<img alt="Sponsor: On GitHub" src="https://img.shields.io/badge/sponsor-on_github-21bb42.svg" />
    </a>
	<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
    <img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
</p>

## Usage

```shell
npm i template-typescript-node-package

import { greet } from "template-typescript-node-package";

greet("Hello, world!");

Development

See .github/CONTRIBUTING.md.
Thanks! 💖

Contributors

Josh Goldberg 🐛 💻 🖋 💡 🤔 🚇 🚧 📦 📆 👀 🛡️ 🔧 ⚠️

Jeff Wen 🔧

Paul Esch-Laurent 🔧

NazCodeland 🔧

💙 This package is based on @JoshuaKGoldberg's template-typescript-node-package.

<!-- You can remove this notice if you don't want it 🙂 no worries! -->

> 💙 This package is based on [@JoshuaKGoldberg](https://github.com/JoshuaKGoldberg)'s [template-typescript-node-package](https://github.com/JoshuaKGoldberg/template-typescript-node-package).

[allcontributors]

@johnnyreilly

I could not determine your intention.

Basic usage: @all-contributors please add @Someone for code, doc and infra

For other usages see the documentation

[johnnyreilly]

Ignore me @allcontibutors. This is going to screw you up too but that's life 😉

I am slightly egotistically keeping myself in that list for "tool" because hey, it's my tooling that set up the package! But similar to the author portion, agreed, you the setup user should be added to it.

I understand that, but I suspect users and potential users may take the view "look, the electricity company is in some way a contributor to this, in that without electricity, this wouldn't be here. But it's not relevant - I don't want it". Harsh, but quite possibly a common sentiment.

[johnnyreilly]

Oh and a question:

ACCESS_TOKEN: A GitHub PAT with repo permissions

I've an idea there's a built in token that GitHub Actions can access - could that be used instead?

Yeah ${{ secrets.GITHUB_TOKEN }}

That's built in and requires no setup - would that work for this?

[johnnyreilly]

github actions also not updated by the looks: https://github.com/johnnyreilly/remark-cloudinary-docusaurus/actions/runs/3772083366/jobs/6412821035

[johnnyreilly]

Dammit - it published src and not lib

https://www.npmjs.com/package/remark-cloudinary-docusaurus?activeTab=explore

[JoshuaKGoldberg]

On the bright side, this is the first time I've seen activeTab=explore in action on npmjs.com! 🙃

[johnnyreilly]

Same!

[johnnyreilly]

Probably going to call it for now, but somehow there's a way to make (I guess) release-it use lib instead of src when it publishes. Don't know what though

[johnnyreilly]

Probably something to do with this: https://github.com/release-it/release-it/blob/HEAD/docs/npm.md#publish-path

But it looks like release-it may not have run the build prior to it perhaps?

[johnnyreilly]

trying this: johnnyreilly/rehype-cloudinary-docusaurus@a2bebf2

[johnnyreilly]

that worked I think

[JoshuaKGoldberg]

Amazing! And yeah it makes a lot of sense. Up for sending a PR? You've already contributed so much to this repo, might as well get in the code history too 😄

[johnnyreilly]

yeah sure - probably after Christmas. Merry Christmas Josh!

[JoshuaKGoldberg]

Merry Christmas!

[johnnyreilly]

Haha - I can't work out if there's a latent threat in that GiF 😅

[JoshuaKGoldberg]

@allcontributors add @johnnyreilly for maintenance

[allcontributors]

@JoshuaKGoldberg

I've put up a pull request to add @johnnyreilly! 🎉