Skip to content

Does the README example work? #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ofrobots opened this issue Jul 19, 2017 · 3 comments
Closed

Does the README example work? #47

ofrobots opened this issue Jul 19, 2017 · 3 comments

Comments

@ofrobots
Copy link

ofrobots commented Jul 19, 2017

The README has:

echo '{"extends": ["@commitlint/config-angular"]}' > .commitlintrc

Looking at the code, I see:

	const legacy = rc('conventional-changelog-lint');
	const legacyFound = typeof legacy.config === 'string';

	const found = resolveable('./commitlint.config');
	const raw = found ? importFrom(process.cwd(), './commitlint.config') : {};

So it seems that the preferred config file name is commitlint.config.js rather than .commitlintrc?

$ echo "foo" | $(npm bin)/commitlint
⧗   input: foo
✔   found 0 problems, 0 warnings

$ mv .commitlintrc commitlint.config.js

$ echo "foo" | $(npm bin)/commitlint
⧗   input: foo
✖   message may not be empty [subject-empty]
✖   type may not be empty [type-empty]
✖   found 2 problems, 0 warnings
@marionebl
Copy link
Contributor

Thanks for reporting - this is indeed faulty documentation.
The preferred and working config file is commitlint.config.js

marionebl added a commit that referenced this issue Jul 19, 2017
marionebl added a commit that referenced this issue Jul 19, 2017
@marionebl
Copy link
Contributor

The examples should be correct now throughout all docs. Follow-up feature in #48

@ofrobots
Copy link
Author

👍 Thanks for fixing!

bpedersen pushed a commit to bpedersen/commitlint that referenced this issue Oct 15, 2019
This PR convert the code base to Typescript, the changes are the following:

- migrate code base to Typescript (3.4.x)
- enable `eslint` and `@typescript-eslint/eslint-plugin` (warnings still need to be addressed in future pull request
- update relevant dependencies for this PR (linting, etc)
- enable `bundlezise` (it was disabled for some reason)

* refactor: refactoring to typescript

* refactor: migrating to typescript

* refactor: applied feedbacks

* fix: fixed conflicts

* refactored: changed registry

* refactor: updated registry & removed unnecessary lib

* fix: fixed registry ur

* fix: fixed page load

* refactor: refactored footer wip

* refactor: converting to ts..wip

* refactor: converting to ts. wip

* refactor: converting to ts. wip

* refactor: converting to ts

* refactor: converting to ts

* fix: fixed load errors

* refactor: converted files to ts

* refactor: removed flow from tests

* fix: removed transpiled files

* refactor: added ts-ignore

* fix: fixed errors

* fix: fixed types

* fix: fixing jest import -.-

* fix: fixing lint errors

* fix: fixing lint errors

* fix: fixed lint errors

* refactor: removed unnecessary tsconfig's config

* fix: fixing errors

* fix: fixed warning

* fix: fixed test

* refactor: wip

* refactor: wip

* refactor: wip

* fix: fixing tests: wip

* wip

* wip

* fix: fixed search test

* wip

* fix: fixing lint errors

* fix: re-added stylelint

* refactor: updated stylelint script

* fix: fixed: 'styles.js'  were found.

* fix: fixed Search tests

* chore: enable eslint

eslint needs expecitely to know which file has to lint, by default is JS, in this case we need also ts,tsx files eslint . --ext .js,.ts

* chore: vcode eslint settings

* chore: restore eslint previous conf

* chore: clean jest config

* chore: fix eslint warnings

* chore: eslint errors cleared

chore: clean warnings

chore: remove github actions test phases

chore: remove dupe rule

* chore: update handler name

* chore: restore logo from img to url css prop

- loading images with css is more performant than using img html tags, switching this might be a breaking change
- restore no-empty-source seems the linting do not accept false
- update snapshots
- remove @material-ui/styles

* chore: update stylelint linting

* chore: update stylelint linting

* chore: fix a mistake on move tabs to a function

* chore: eanble bundlezie

* chore: use default_executor in circleci

* chore: update readme
bpedersen pushed a commit to bpedersen/commitlint that referenced this issue Oct 15, 2019
- Remove unnecessary quotes in Emotion css templated string
- Revert md prop removed in conventional-changelog#47 (with the size set before that)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants