From d3b8f8889db7fe44e678e1da2395b1ede41807ad Mon Sep 17 00:00:00 2001
From: Lucas Cimon <925560+Lucas-C@users.noreply.github.com>
Date: Mon, 29 Nov 2021 23:51:02 +0100
Subject: [PATCH 04/28] fix: scriptName + improving usage messages (#305)
* Improving usage messages + fixing scriptName
* Fixes post-review
---
other/MAINTAINING.md | 8 ++++----
src/cli.js | 14 +++++---------
2 files changed, 9 insertions(+), 13 deletions(-)
diff --git a/other/MAINTAINING.md b/other/MAINTAINING.md
index 5232261b..a31d2adf 100644
--- a/other/MAINTAINING.md
+++ b/other/MAINTAINING.md
@@ -41,8 +41,8 @@ as you want/need to. Nobody can ask any more of you than that.
As a maintainer, you're fine to make your branches on the main repo or on your own fork. Either
way is fine.
-When we receive a pull request, a travis build is kicked off automatically (see the `.travis.yml`
-for what runs in the travis build). We avoid merging anything that breaks the travis build.
+When we receive a pull request, a Circle CI build is kicked off automatically (see the `.circleci/`
+directory for what runs in the CI pipeline). We avoid merging anything that breaks the CI pipeline.
Please review PRs and focus on the code rather than the individual. You never know when this is
someone's first ever PR and we want their experience to be as positive as possible, so be
@@ -56,8 +56,8 @@ about that.
## Release
-Our releases are automatic. They happen whenever code lands into `master`. A travis build gets
-kicked off and if it's successful, a tool called
+Our releases are automatic. They happen whenever code lands into `master`. A Circle CI build
+build gets kicked off and if it's successful, a tool called
[`semantic-release`](https://github.com/semantic-release/semantic-release) is used to
automatically publish a new release to npm as well as a changelog to GitHub. It is only able to
determine the version and whether a release is necessary by the git commit messages. With this
diff --git a/src/cli.js b/src/cli.js
index 4d356819..7be588ec 100755
--- a/src/cli.js
+++ b/src/cli.js
@@ -16,22 +16,18 @@ const cwd = process.cwd()
const defaultRCFile = path.join(cwd, '.all-contributorsrc')
const yargv = yargs
+ .scriptName('all-contributors')
.help('help')
.alias('h', 'help')
.alias('v', 'version')
.version()
.recommendCommands()
- .command('generate', 'Generate the list of contributors')
- .usage('Usage: $0 generate')
- .command('add', 'add a new contributor')
- .usage('Usage: $0 add ')
- .command('init', 'Prepare the project to be used with this tool')
- .usage('Usage: $0 init')
+ .command('generate', `Generate the list of contributors\n\nUSAGE: all-contributors generate`)
+ .command('add', `Add a new contributor\n\nUSAGE: all-contributors add `)
+ .command('init', `Prepare the project to be used with this tool\n\nUSAGE: all-contributors init`)
.command(
'check',
- 'Compares contributors from the repository with the ones credited in .all-contributorsrc',
- )
- .usage('Usage: $0 check')
+ `Compare contributors from the repository with the ones credited in .all-contributorsrc'\n\nUSAGE: all-contributors check`)
.boolean('commit')
.default('files', ['README.md'])
.default('contributorsPerLine', 7)
From 5dbb7213b08a7badc6a357b2af719c2c5daef9a3 Mon Sep 17 00:00:00 2001
From: "allcontributors[bot]"
<46447321+allcontributors[bot]@users.noreply.github.com>
Date: Tue, 30 Nov 2021 09:43:56 -0800
Subject: [PATCH 05/28] docs: add Lucas-C as a contributor for doc (#306)
* docs: update README.md [skip ci]
* docs: update .all-contributorsrc [skip ci]
Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
---
.all-contributorsrc | 11 ++++-
README.md | 109 ++++++++++++++++++++++----------------------
2 files changed, 65 insertions(+), 55 deletions(-)
diff --git a/.all-contributorsrc b/.all-contributorsrc
index 4856b698..afe1e39a 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -1,6 +1,6 @@
{
"projectOwner": "all-contributors",
- "projectName": "all-contributors-cli",
+ "projectName": "cli",
"imageSize": 100,
"repoType": "github",
"commit": false,
@@ -567,6 +567,15 @@
"contributions": [
"security"
]
+ },
+ {
+ "login": "Lucas-C",
+ "name": "Lucas Cimon",
+ "avatar_url": "https://avatars.githubusercontent.com/u/925560?v=4",
+ "profile": "https://chezsoi.org/lucas/blog/",
+ "contributions": [
+ "doc"
+ ]
}
],
"skipCi": true
diff --git a/README.md b/README.md
index ff03185e..1eae84d9 100644
--- a/README.md
+++ b/README.md
@@ -80,82 +80,83 @@ Thanks goes to these wonderful people
diff --git a/assets/logo-small.svg b/assets/logo-small.svg
new file mode 100644
index 00000000..b8e512af
--- /dev/null
+++ b/assets/logo-small.svg
@@ -0,0 +1,6 @@
+
diff --git a/src/generate/__tests__/__snapshots__/index.js.snap b/src/generate/__tests__/__snapshots__/index.js.snap
index 15d4d74b..7278f002 100644
--- a/src/generate/__tests__/__snapshots__/index.js.snap
+++ b/src/generate/__tests__/__snapshots__/index.js.snap
@@ -18,6 +18,46 @@ These people contributed to the project:
Jeroen Engels is awesome!
+
+
+
+
+
+
+
+
+
+
+Thanks a lot everyone!"
+`;
+
+exports[`replace the content between the ALL-CONTRIBUTORS-LIST tags by a table of contributors with linkToUsage 1`] = `
+"# project
+
+Description
+
+## Contributors
+These people contributed to the project:
+
+
+
+
@@ -52,6 +92,52 @@ These people contributed to the project:
Kent C. Dodds is awesome!
+
+
+
+
+
+
+
+
+
+
+Thanks a lot everyone!"
+`;
+
+exports[`split contributors into multiples lines when there are too many with linkToUsage 1`] = `
+"# project
+
+Description
+
+## Contributors
+These people contributed to the project:
+
+
+
+
-
-
-
@@ -68,6 +65,34 @@ These people contributed to the project:
Thanks a lot everyone!"
`;
+exports[`replace the content between the ALL-CONTRIBUTORS-LIST tags by a table of contributors without linkToUsage 1`] = `
+"# project
+
+Description
+
+## Contributors
+These people contributed to the project:
+
+
+
+
+
+
+
Kent C. Dodds is awesome!
+
Divjot Singh is awesome!
+
Jeroen Engels is awesome!
+
+
+
+
+
+
+
+
+
+Thanks a lot everyone!"
+`;
+
exports[`split contributors into multiples lines when there are too many 1`] = `
"# project
@@ -92,9 +117,6 @@ These people contributed to the project:
Kent C. Dodds is awesome!
-
-
-
diff --git a/src/generate/__tests__/index.js b/src/generate/__tests__/index.js
index cff3f7c1..524e58b8 100644
--- a/src/generate/__tests__/index.js
+++ b/src/generate/__tests__/index.js
@@ -47,7 +47,24 @@ test('replace the content between the ALL-CONTRIBUTORS-LIST tags by a table of c
const {kentcdodds, bogas04} = contributors
const {options, jfmengels, content} = fixtures()
const contributorList = [kentcdodds, bogas04, jfmengels]
- const result = generate(Object.assign(options, { linkToUsage: true }), contributorList, content)
+ const result = generate(
+ Object.assign(options, {linkToUsage: true}),
+ contributorList,
+ content,
+ )
+
+ expect(result).toMatchSnapshot()
+})
+
+test('replace the content between the ALL-CONTRIBUTORS-LIST tags by a table of contributors without linkToUsage', () => {
+ const {kentcdodds, bogas04} = contributors
+ const {options, jfmengels, content} = fixtures()
+ const contributorList = [kentcdodds, bogas04, jfmengels]
+ const result = generate(
+ Object.assign(options, {linkToUsage: false}),
+ contributorList,
+ content,
+ )
expect(result).toMatchSnapshot()
})
@@ -81,7 +98,11 @@ test('split contributors into multiples lines when there are too many with linkT
kentcdodds,
kentcdodds,
]
- const result = generate(Object.assign(options, { linkToUsage: true }), contributorList, content)
+ const result = generate(
+ Object.assign(options, {linkToUsage: true}),
+ contributorList,
+ content,
+ )
expect(result).toMatchSnapshot()
})
diff --git a/src/generate/index.js b/src/generate/index.js
index 6dac4250..78de5e36 100644
--- a/src/generate/index.js
+++ b/src/generate/index.js
@@ -62,6 +62,7 @@ function formatFooter(options) {
function generateContributorsList(options, contributors) {
const tableFooter = formatFooter(options)
+ let tableFooterContent = ''
return _.flow(
_.sortBy(contributor => {
@@ -76,7 +77,10 @@ function generateContributorsList(options, contributors) {
_.map(formatLine),
_.join('\n \n
\n '),
newContent => {
- return `\n
\n \n
\n ${newContent}\n
\n \n \n ${tableFooter}\n \n
\n\n`
+ if (options.linkToUsage) {
+ tableFooterContent = `
From 554667bfdd323c79b75e835ac2edd3f371d8945f Mon Sep 17 00:00:00 2001
From: QriLa | Hyeon Gu <68494132+qyurila@users.noreply.github.com>
Date: Tue, 11 Oct 2022 05:52:06 +0900
Subject: [PATCH 28/28] feat: Add `width` and `valign` attributes for cleaner
(#344)
---
.../__tests__/__snapshots__/index.js.snap | 74 +++++++++++++------
src/generate/__tests__/index.js | 15 ++++
src/generate/index.js | 14 +++-
3 files changed, 76 insertions(+), 27 deletions(-)
diff --git a/src/generate/__tests__/__snapshots__/index.js.snap b/src/generate/__tests__/__snapshots__/index.js.snap
index 33183570..b8f576ac 100644
--- a/src/generate/__tests__/__snapshots__/index.js.snap
+++ b/src/generate/__tests__/__snapshots__/index.js.snap
@@ -13,9 +13,9 @@ These people contributed to the project:
-
Kent C. Dodds is awesome!
-
Divjot Singh is awesome!
-
Jeroen Engels is awesome!
+
Kent C. Dodds is awesome!
+
Divjot Singh is awesome!
+
Jeroen Engels is awesome!
@@ -41,9 +41,9 @@ These people contributed to the project:
-
Kent C. Dodds is awesome!
-
Divjot Singh is awesome!
-
Jeroen Engels is awesome!
+
Kent C. Dodds is awesome!
+
Divjot Singh is awesome!
+
Jeroen Engels is awesome!
@@ -78,9 +78,9 @@ These people contributed to the project:
-
Kent C. Dodds is awesome!
-
Divjot Singh is awesome!
-
Jeroen Engels is awesome!
+
Kent C. Dodds is awesome!
+
Divjot Singh is awesome!
+
Jeroen Engels is awesome!
@@ -106,15 +106,15 @@ These people contributed to the project:
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
@@ -140,15 +140,15 @@ These people contributed to the project:
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
-
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
+
Kent C. Dodds is awesome!
@@ -169,3 +169,31 @@ These people contributed to the project:
Thanks a lot everyone!"
`;
+
+exports[`validate if cell width attribute is floored correctly 1`] = `
+"# project
+
+Description
+
+## Contributors
+These people contributed to the project:
+
+
+
+
+ ![](\\"https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg\\"){kind=logo}
+ 
