Skip to content

Commit

Permalink
Update to "tmpl-go" template repository version 0.5.0 (#26)
Browse files Browse the repository at this point in the history
Updated to `tmpl-go` version 0.5.0 [1] (including version 0.4.0 [2])
that...

1. ...introduces the initial project documentation [3].
2. ...updates golangci-lint to the currently latest version 1.32.0 [4]
   which introduces new linters like errorlint [5], tparallel [6] and
   wrapcheck [7].
3. ...updates to "tmpl" version 0.7.0 (GH-25 [8] GH-34 [9]).
   This includes...
   - ...a new configuration file for automated dependency updates and
     security alerts [10] with Dependabot [11]. Next to update
     configurations for the CI/CD GitHub action workflow [12] and
     Yarn/NPM dependencies [13], the file has been extended to support
     Go modules [14].
   - ...updates to the latest Node.js package dependency & GitHub Action
     versions.
   - ...a change of the NPM package name to use a namespace [15] which
     helps to prevent collisions with already existing NPM packages like
     tmpl [16].

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.5.0
[2]: https://github.com/svengreb/tmpl-go/releases/tag/v0.4.0
[3]: svengreb/tmpl-go#32
[4]: svengreb/tmpl-go#21
[5]: https://github.com/polyfloyd/go-errorlint
[6]: https://github.com/moricho/tparallel
[7]: https://github.com/tomarrell/wrapcheck
[8]: svengreb/tmpl-go#25
[9]: svengreb/tmpl-go#34
[10]: svengreb/tmpl#52
[11]: https://dependabot.com
[12]: https://github.com/svengreb/tmpl#cicd-action-workflow
[13]: https://github.com/svengreb/tmpl#nodejs-yarn-and-npm
[14]: https://golang.org/ref/mod
[15]: svengreb/tmpl#48
[16]: https://www.npmjs.com/package/tmpl

Closes GH-25
  • Loading branch information
svengreb committed Nov 11, 2020
1 parent 175478e commit 15285fb
Show file tree
Hide file tree
Showing 6 changed files with 75 additions and 31 deletions.
41 changes: 41 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Copyright (c) 2020-present Sven Greb <[email protected]>
# This source code is licensed under the MIT license found in the LICENSE file.

# Configuration for the native Dependabot integration.
# See the official GitHub documentations for more details:
# - https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/configuration-options-for-dependency-updates
# - https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/about-dependabot-version-updates
# - https://docs.github.com/en/free-pro-team@latest/github/managing-security-vulnerabilities/about-dependabot-security-updates
# - https://github.com/features#features-security

version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
reviewers:
- "svengreb"
labels:
- "scope-quality"
- "scope-security"

- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "weekly"
reviewers:
- "svengreb"
labels:
- "scope-quality"
- "scope-security"

- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
reviewers:
- "svengreb"
labels:
- "scope-quality"
- "scope-security"
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v2
- name: "Setup Node.js version ${{ matrix.node-version }}"
uses: actions/setup-node@v1
uses: actions/setup-node@v2.1.2
with:
node-version: "14.x"
- name: Install Node modules
Expand All @@ -51,7 +51,7 @@ jobs:
# See https://github.com/golangci/golangci-lint-action for more details.
uses: golangci/golangci-lint-action@v2
with:
version: v1.31
version: v1.32
test:
strategy:
matrix:
Expand Down
9 changes: 6 additions & 3 deletions .golangci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ linters:
- dogsled
- dupl
- errcheck
- errorlint
- exhaustive
- gochecknoinits
- goconst
Expand Down Expand Up @@ -59,12 +60,14 @@ linters:
- staticcheck
- structcheck
- stylecheck
- tparallel
- typecheck
- unconvert
- unparam
- unused
- varcheck
- whitespace
- wrapcheck
# Run all linters, not only fast ones.
fast: false

Expand Down Expand Up @@ -136,12 +139,12 @@ linters-settings:
misspell:
locale: US
ignore-words:
- tmpl
- tmpl-go
- inkpen
- nib

# Options for analysis runs.
run:
deadline: 15m

service:
golangci-lint-version: 1.31.x
golangci-lint-version: 1.32.x
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before you continue with these contribution guidelines we highly recommend to re

### Bug Reports

A bug is a _demonstrable problem_ that is caused by the code in the repository. This section guides you through submitting a bug report for tmpl-go. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior and find related reports.
A bug is a _demonstrable problem_ that is caused by the code in the repository. This section guides you through submitting a bug report for nib. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior and find related reports.

**Do NOT report security vulnerabilities in public issues!** Please only contact one of the core team members or project owner in a responsible manner by [email][gh-mailmap] or via [email protected]. We will assess the issue as soon as possible on a best-effort basis and will give you an estimate for when we have a fix and release available for an eventual public disclosure.

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "nib",
"name": "@svengreb/nib",
"version": "0.1.0",
"description": "A stylish, log-level based line printer for human-facing Go CLI applications",
"author": {
Expand All @@ -26,7 +26,7 @@
},
"devDependencies": {
"husky": "^4.3.0",
"lint-staged": "^10.4.0",
"lint-staged": "^10.5.1",
"npm-run-all": "^4.1.5",
"prettier": "^2.1.2",
"remark-cli": "^8.0.1",
Expand Down
46 changes: 23 additions & 23 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -267,10 +267,10 @@ color-name@~1.1.4:
resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2"
integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==

commander@^6.0.0:
version "6.1.0"
resolved "https://registry.yarnpkg.com/commander/-/commander-6.1.0.tgz#f8d722b78103141006b66f4c7ba1e97315ba75bc"
integrity sha512-wl7PNrYWd2y5mp1OK/LhTlv8Ff4kQJQRXXAvF+uU/TPNiVJUxZLRYGj/B0y/lPGAVcSbJqH2Za/cvHmrPMC8mA==
commander@^6.2.0:
version "6.2.0"
resolved "https://registry.yarnpkg.com/commander/-/commander-6.2.0.tgz#b990bfb8ac030aedc6d11bc04d1488ffef56db75"
integrity sha512-zP4jEKbe8SHzKJYQmq8Y9gYjtO/POJLgIdKgV7B9qNmABVFVc+ctqSX6iXh4mCpJfRBOabiZ2YKPg8ciDw6C+Q==

compare-versions@^3.6.0:
version "3.6.0"
Expand Down Expand Up @@ -323,7 +323,7 @@ cross-spawn@^7.0.0:
shebang-command "^2.0.0"
which "^2.0.1"

debug@^4.0.0, debug@^4.1.1:
debug@^4.0.0, debug@^4.2.0:
version "4.2.0"
resolved "https://registry.yarnpkg.com/debug/-/debug-4.2.0.tgz#7f150f93920e94c58f5574c2fd01a3110effe7f1"
integrity sha512-IX2ncY78vDTjZMFUdmsvIRFY2Cf4FnD0wRs+nQwJU8Lu99/tPFdb0VybiiMTPe3I6rQmwsqQqRBvxU+bZ/I8sg==
Expand Down Expand Up @@ -422,10 +422,10 @@ esprima@^4.0.0:
resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71"
integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==

execa@^4.0.3:
version "4.0.3"
resolved "https://registry.yarnpkg.com/execa/-/execa-4.0.3.tgz#0a34dabbad6d66100bd6f2c576c8669403f317f2"
integrity sha512-WFDXGHckXPWZX19t1kCsXzOpqX9LWYNqn4C+HqZlk/V0imTkzJZqf87ZBhvpHaftERYknpk0fjSylnXVlVgI0A==
execa@^4.1.0:
version "4.1.0"
resolved "https://registry.yarnpkg.com/execa/-/execa-4.1.0.tgz#4e5491ad1572f2f17a77d388c6c857135b22847a"
integrity sha512-j5W0//W7f8UxAn8hXVnwG8tLwdiUy4FJLcSupCg6maBYZDpyBvTApK7KyuI4bKj8KOh1r2YH+6ucuYtJv1bTZA==
dependencies:
cross-spawn "^7.0.0"
get-stream "^5.0.0"
Expand Down Expand Up @@ -815,39 +815,39 @@ lines-and-columns@^1.1.6:
resolved "https://registry.yarnpkg.com/lines-and-columns/-/lines-and-columns-1.1.6.tgz#1c00c743b433cd0a4e80758f7b64a57440d9ff00"
integrity sha1-HADHQ7QzzQpOgHWPe2SldEDZ/wA=

lint-staged@^10.4.0:
version "10.4.0"
resolved "https://registry.yarnpkg.com/lint-staged/-/lint-staged-10.4.0.tgz#d18628f737328e0bbbf87d183f4020930e9a984e"
integrity sha512-uaiX4U5yERUSiIEQc329vhCTDDwUcSvKdRLsNomkYLRzijk3v8V9GWm2Nz0RMVB87VcuzLvtgy6OsjoH++QHIg==
lint-staged@^10.5.1:
version "10.5.1"
resolved "https://registry.yarnpkg.com/lint-staged/-/lint-staged-10.5.1.tgz#901e915c2360072dded0e7d752a0d9a49e079daa"
integrity sha512-fTkTGFtwFIJJzn/PbUO3RXyEBHIhbfYBE7+rJyLcOXabViaO/h6OslgeK6zpeUtzkDrzkgyAYDTLAwx6JzDTHw==
dependencies:
chalk "^4.1.0"
cli-truncate "^2.1.0"
commander "^6.0.0"
commander "^6.2.0"
cosmiconfig "^7.0.0"
debug "^4.1.1"
debug "^4.2.0"
dedent "^0.7.0"
enquirer "^2.3.6"
execa "^4.0.3"
listr2 "^2.6.0"
execa "^4.1.0"
listr2 "^3.2.2"
log-symbols "^4.0.0"
micromatch "^4.0.2"
normalize-path "^3.0.0"
please-upgrade-node "^3.2.0"
string-argv "0.3.1"
stringify-object "^3.3.0"

listr2@^2.6.0:
version "2.6.2"
resolved "https://registry.yarnpkg.com/listr2/-/listr2-2.6.2.tgz#4912eb01e1e2dd72ec37f3895a56bf2622d6f36a"
integrity sha512-6x6pKEMs8DSIpA/tixiYY2m/GcbgMplMVmhQAaLFxEtNSKLeWTGjtmU57xvv6QCm2XcqzyNXL/cTSVf4IChCRA==
listr2@^3.2.2:
version "3.2.2"
resolved "https://registry.yarnpkg.com/listr2/-/listr2-3.2.2.tgz#d20feb75015e506992b55af40722ba1af168b8f1"
integrity sha512-AajqcZEUikF2ioph6PfH3dIuxJclhr3i3kHgTOP0xeXdWQohrvJAAmqVcV43/GI987HFY/vzT73jYXoa4esDHg==
dependencies:
chalk "^4.1.0"
cli-truncate "^2.1.0"
figures "^3.2.0"
indent-string "^4.0.0"
log-update "^4.0.0"
p-map "^4.0.0"
rxjs "^6.6.2"
rxjs "^6.6.3"
through "^2.3.8"

load-json-file@^4.0.0:
Expand Down Expand Up @@ -2055,7 +2055,7 @@ restore-cursor@^3.1.0:
onetime "^5.1.0"
signal-exit "^3.0.2"

rxjs@^6.6.2:
rxjs@^6.6.3:
version "6.6.3"
resolved "https://registry.yarnpkg.com/rxjs/-/rxjs-6.6.3.tgz#8ca84635c4daa900c0d3967a6ee7ac60271ee552"
integrity sha512-trsQc+xYYXZ3urjOiJOuCOa5N3jAZ3eiSpQB5hIT8zGlL2QfnHLJ2r7GMkBGuIausdJN1OneaI6gQlsqNHHmZQ==
Expand Down

0 comments on commit 15285fb

Please sign in to comment.