Skip to content

Commit

Permalink
chore: setup repo
Browse files Browse the repository at this point in the history
  • Loading branch information
s1adem4n committed Jul 30, 2023
1 parent 4749ee7 commit d64e112
Show file tree
Hide file tree
Showing 108 changed files with 175 additions and 6,091 deletions.
212 changes: 15 additions & 197 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -5,216 +5,34 @@
"contributors": [
{
"avatar_url": "https://avatars.githubusercontent.com/u/3335181?v=4",
"contributions": [
"bug",
"code",
"maintenance",
"review",
"tool",
"doc",
"infra",
"test"
],
"contributions": ["tool"],
"login": "JoshuaKGoldberg",
"name": "Josh Goldberg",
"profile": "http://www.joshuakgoldberg.com"
},
{
"login": "sinchang",
"name": "Jeff Wen",
"avatar_url": "https://avatars.githubusercontent.com/u/3297859?v=4",
"profile": "https://sinchang.me",
"contributions": [
"code"
]
},
{
"login": "Pinjasaur",
"name": "Paul Esch-Laurent",
"avatar_url": "https://avatars.githubusercontent.com/u/6335792?v=4",
"profile": "https://paulisaweso.me/",
"contributions": [
"code"
]
},
{
"login": "NazCodeland",
"name": "NazCodeland",
"avatar_url": "https://avatars.githubusercontent.com/u/113494366?v=4",
"profile": "https://github.com/NazCodeland",
"contributions": [
"code"
]
},
{
"login": "johnnyreilly",
"name": "John Reilly",
"avatar_url": "https://avatars.githubusercontent.com/u/1010525?v=4",
"profile": "https://blog.johnnyreilly.com/",
"contributions": [
"code"
]
},
{
"login": "webpro",
"name": "Lars Kappert",
"avatar_url": "https://avatars.githubusercontent.com/u/456426?v=4",
"profile": "https://webpro.nl",
"contributions": [
"code"
]
},
{
"login": "RebeccaStevens",
"name": "Rebecca Stevens",
"avatar_url": "https://avatars.githubusercontent.com/u/7224206?v=4",
"profile": "https://github.com/RebeccaStevens",
"login": "s1adem4n",
"name": "s1adem4n",
"avatar_url": "https://avatars.githubusercontent.com/u/68190441?v=4",
"profile": "https://github.com/s1adem4n",
"contributions": [
"code",
"infra"
]
},
{
"login": "ronthetech",
"name": "Ron Jean-Francois",
"avatar_url": "https://avatars.githubusercontent.com/u/105710107?v=4",
"profile": "http://ronjeanfrancois.com",
"contributions": [
"code",
"infra"
]
},
{
"login": "nowyDEV",
"name": "Dominik Nowik",
"avatar_url": "https://avatars.githubusercontent.com/u/12304307?v=4",
"profile": "https://github.com/nowyDEV",
"contributions": [
"tool",
"code"
]
},
{
"login": "TAKANOME-DEV",
"name": "takanomedev",
"avatar_url": "https://avatars.githubusercontent.com/u/79809121?v=4",
"profile": "https://github.com/TAKANOME-DEV",
"contributions": [
"code"
]
},
{
"login": "emday4prez",
"name": "Emerson",
"avatar_url": "https://avatars.githubusercontent.com/u/35363144?v=4",
"profile": "https://github.com/emday4prez",
"contributions": [
"code"
]
},
{
"login": "jsjoeio",
"name": "Joe Previte",
"avatar_url": "https://avatars.githubusercontent.com/u/3806031?v=4",
"profile": "https://typescriptcourse.com/tutorials",
"contributions": [
"bug",
"code"
]
},
{
"login": "navin-moorthy",
"name": "Navin Moorthy",
"avatar_url": "https://avatars.githubusercontent.com/u/39694575?v=4",
"profile": "https://navinmoorthy.me/",
"contributions": [
"bug",
"code"
]
},
{
"login": "garuna-m6",
"name": "Anurag",
"avatar_url": "https://avatars.githubusercontent.com/u/23234342?v=4",
"profile": "https://github.com/garuna-m6",
"contributions": [
"code"
]
},
{
"login": "danielroe",
"name": "Daniel Roe",
"avatar_url": "https://avatars.githubusercontent.com/u/28706372?v=4",
"profile": "https://roe.dev/",
"contributions": [
"code"
]
},
{
"login": "the-lazy-learner",
"name": "Sudhansu",
"avatar_url": "https://avatars.githubusercontent.com/u/13695177?v=4",
"profile": "https://github.com/the-lazy-learner",
"contributions": [
"code"
]
},
{
"login": "RNR1",
"name": "Ron Braha",
"avatar_url": "https://avatars.githubusercontent.com/u/45559220?v=4",
"profile": "https://linktr.ee/ronbraha",
"contributions": [
"code",
"design",
"test"
]
},
{
"login": "tungbq",
"name": "Tung Bui (Leo)",
"avatar_url": "https://avatars.githubusercontent.com/u/85242618?v=4",
"profile": "https://github.com/tungbq",
"contributions": [
"code"
]
},
{
"login": "orta",
"name": "Orta Therox",
"avatar_url": "https://avatars.githubusercontent.com/u/49038?v=4",
"profile": "https://orta.io",
"contributions": [
"code"
]
},
{
"login": "promise-dash",
"name": "Promise Dash",
"avatar_url": "https://avatars.githubusercontent.com/u/86062880?v=4",
"profile": "https://github.com/promise-dash",
"contributions": [
"code"
]
},
{
"login": "jolg42",
"name": "JoΓ«l Galeran",
"avatar_url": "https://avatars.githubusercontent.com/u/1328733?v=4",
"profile": "https://twitter.com/Jolg42",
"contributions": [
"code"
"content",
"doc",
"ideas",
"infra",
"maintenance",
"projectManagement",
"tool"
]
}
],
"contributorsPerLine": 7,
"contributorsSortAlphabetically": true,
"files": [
"README.md"
],
"files": ["README.md"],
"imageSize": 100,
"projectName": "template-typescript-node-package",
"projectOwner": "JoshuaKGoldberg",
"projectName": "soundcloud",
"projectOwner": "s1adem4n",
"repoHost": "https://github.com",
"repoType": "github",
"commitType": "docs"
Expand Down
10 changes: 0 additions & 10 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,13 +1,3 @@
/*
πŸ‘‹ Hi! This ESLint configuration contains a lot more stuff than many repos'!
You can read from it to see all sorts of linting goodness, but don't worry -
it's not something you need to exhaustively understand immediately. πŸ’™
If you're interested in learning more, see the 'getting started' docs on:
- ESLint: https://eslint.org
- typescript-eslint: https://typescript-eslint.io
*/

/** @type {import("@types/eslint").Linter.Config} */
module.exports = {
env: {
Expand Down
10 changes: 5 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing

Thanks for your interest in contributing to `template-typescript-node-package`! πŸ’–
Thanks for your interest in contributing to `soundcloud`! πŸ’–

> After this page, see [DEVELOPMENT.md](./DEVELOPMENT.md) for local development instructions.
Expand All @@ -10,7 +10,7 @@ This project contains a [Contributor Covenant code of conduct](./CODE_OF_CONDUCT

## Reporting Issues

Please do [report an issue on the issue tracker](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.
Please do [report an issue on the issue tracker](https://github.com/s1adem4n/soundcloud/issues/new/choose) if there's any bugfix, documentation improvement, or general enhancement you'd like to see in the repository! Please fully fill out all required fields in the most appropriate issue form.

## Sending Contributions

Expand All @@ -22,8 +22,8 @@ There are two steps involved:

### Finding an Issue

With the exception of very small typos, all changes to this repository generally need to correspond to an [open issue marked as `accepting prs` on the issue tracker](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22).
If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22+label%3A%22good+first+issue%22+no%3Aassignee).
With the exception of very small typos, all changes to this repository generally need to correspond to an [open issue marked as `accepting prs` on the issue tracker](https://github.com/s1adem4n/soundcloud/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22).
If this is your first time contributing, consider searching for [unassigned issues that also have the `good first issue` label](https://github.com/s1adem4n/soundcloud/issues?q=is%3Aopen+is%3Aissue+label%3A%22accepting+prs%22+label%3A%22good+first+issue%22+no%3Aassignee).
If the issue you'd like to fix isn't found on the issue, see [Reporting Issues](#reporting-issues) for filing your own (please do!).

### Sending a Pull Request
Expand All @@ -34,7 +34,7 @@ Be sure to fill out the pull request template's requested information -- otherwi
PRs are also expected to have a title that adheres to [commitlint](https://github.com/conventional-changelog/commitlint).
Only PR titles need to be in that format, not individual commits.
Don't worry if you get this wrong: you can always change the PR title after sending it.
Check [previously merged PRs](https://github.com/JoshuaKGoldberg/template-typescript-node-package/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.
Check [previously merged PRs](https://github.com/s1adem4n/soundcloud/pulls?q=is%3Apr+is%3Amerged+-label%3Adependencies+) for reference.

#### Draft PRs

Expand Down
24 changes: 4 additions & 20 deletions .github/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo) and [installing pnpm](https://pnpm.io/installation):

```shell
git clone https://github.com/<your-name-here>/template-typescript-node-package
cd template-typescript-node-package
git clone https://github.com/<your-name-here>/soundcloud
cd soundcloud
pnpm install
```

Expand Down Expand Up @@ -59,7 +59,7 @@ Add the `--coverage` flag to compute test coverage and place reports in the `cov
pnpm run test --coverage
```

Note that [console-fail-test](https://github.com/JoshuaKGoldberg/console-fail-test) is enabled for all test runs.
Note that [console-fail-test](https://github.com/s1adem4n/console-fail-test) is enabled for all test runs.
Calls to `console.log`, `console.warn`, and other console methods will cause a test to fail.

### Debugging Tests
Expand Down Expand Up @@ -87,27 +87,11 @@ npm init --yes
Then, in that directory, you can directly call the hydration script:

```shell
node ../template-typescript-node-package/lib/hydrate/index.js -- description "Hooray, trying things out locally."
node ../soundcloud/lib/hydrate/index.js -- description "Hooray, trying things out locally."
```

Along with the hydration script itself, end-to-end tests are removed on package setup.

## The Setup Script

This template's "setup" script is located in `script/`.

### Testing the Setup Script

This template source includes an "end-to-end" test for `script/setup.js`.
You can run it locally on the command-line:

```shell
pnpm run setup:test
```

That end-to-end test executes `script/setup-test-e2e.js`, which:

1. Runs the setup script using `--skip-api`
2. Checks that the local repository's files were changed correctly (e.g. removed setup-only files)

Along with the setup script itself, end-to-end tests are removed on package setup.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: JoshuaKGoldberg
github: s1adem4n
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- Note: Please must use one of our issue templates to file an issue! πŸ›‘ -->
<!-- πŸ‘‰ https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues/new/choose πŸ‘ˆ -->
<!-- πŸ‘‰ https://github.com/s1adem4n/soundcloud/issues/new/choose πŸ‘ˆ -->
<!-- **Issues that should have been filed with a template will be closed without action, and we will ask you to use a template.** -->

<!-- This blank issue template is only for issues that don't fit any of the templates. -->
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/01-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
required: true
- label: I have pulled the latest `main` branch of the repository.
required: true
- label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue) and found none that matched my issue.
- label: I have [searched for related issues](https://github.com/s1adem4n/soundcloud/issues?q=is%3Aissue) and found none that matched my issue.
required: true
type: checkboxes
- attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/02-documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ body:
options:
- label: I have pulled the latest `main` branch of the repository.
required: true
- label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue) and found none that matched my issue.
- label: I have [searched for related issues](https://github.com/s1adem4n/soundcloud/issues?q=is%3Aissue) and found none that matched my issue.
required: true
type: checkboxes
- attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/03-feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
required: true
- label: I have pulled the latest `main` branch of the repository.
required: true
- label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue) and found none that matched my issue.
- label: I have [searched for related issues](https://github.com/s1adem4n/soundcloud/issues?q=is%3Aissue) and found none that matched my issue.
required: true
type: checkboxes
- attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/04-tooling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
required: true
- label: I have pulled the latest `main` branch of the repository.
required: true
- label: I have [searched for related issues](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aissue) and found none that matched my issue.
- label: I have [searched for related issues](https://github.com/s1adem4n/soundcloud/issues?q=is%3Aissue) and found none that matched my issue.
required: true
type: checkboxes
- attributes:
Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!-- πŸ‘‹ Hi, thanks for sending a PR to template-typescript-node-package! πŸ’–.
<!-- πŸ‘‹ Hi, thanks for sending a PR to soundcloud! πŸ’–.
Please fill out all fields below and make sure each item is true and [x] checked.
Otherwise we may not be able to review your PR. -->

## PR Checklist

- [ ] Addresses an existing open issue: fixes #000
- [ ] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/template-typescript-node-package/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [ ] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/template-typescript-node-package/blob/main/.github/CONTRIBUTING.md) were taken
- [ ] That issue was marked as [`status: accepting prs`](https://github.com/s1adem4n/soundcloud/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22)
- [ ] Steps in [CONTRIBUTING.md](https://github.com/s1adem4n/soundcloud/blob/main/.github/CONTRIBUTING.md) were taken

## Overview

Expand Down
Loading

0 comments on commit d64e112

Please sign in to comment.