Suggestion: move pre-commit support to another repo

Question

Suggestion: move pre-commit support to another repo

FloChehab opened this issue 4 years ago · comments

Hi,
First of all, thanks for the awesome tool, I have been using for a couple of years and have never been disappointed ! :)

This issue is more a of a question / suggestion, so sorry if it doesn't fit in the standard issue schema.

Context
I am currently using prettier to format files not related to JavaScript through the https://pre-commit.com/ integration. Because (from what I understand) pre-commit runs npm i . it's pretty slow and bandwidth intensive on this repo (takes around 40-50s to set up in our CI environment).
The other issue is that sometimes, sub-dependencies of prettier are broken (like today, see the error below - v2.0.5).

By looking at the npm page I see that prettier is actually a standalone package: https://www.npmjs.com/package/prettier ; and doing npm i prettier@2.0.5 takes actually less than 1 second, which is pretty great 🎉 .

So here is my suggestion:
Could it be possible to move the 'official' support of pre-commit to another git repo, that would have a simple package.json with only prettier and the same hook file as https://github.com/prettier/prettier/blob/master/.pre-commit-hooks.yaml ?

This would

Be faster to install (which is also good for the 🌍 ),
Avoid deps errors,
Require the fairly small maintenance of another repo.

I have currently switched to https://github.com/awebdeveloper/pre-commit-prettier which is kind of what I am suggesting, but without the native tag support.

Have a nice day !

Sub dependancies errors

An unexpected error has occurred: CalledProcessError: command: ('/home/jenkins/.cache/pre-commit/repole0tq7th/node_env-default/bin/node', '/home/jenkins/.cache/pre-commit/repole0tq7th/node_env-default/bin/npm', 'install')

return code: 1

expected return code: 0

stdout: (none)

stderr:

    npm WARN deprecated rollup-plugin-babel@4.4.0: This package has been deprecated and is no longer maintained. Please use @rollup/plugin-babel.

    npm WARN deprecated json-parser@1.1.5: `json-parser` is deprecated. Please use `comment-json` instead

    npm WARN deprecated chokidar@2.1.8: Chokidar 2 will break on node v14+. Upgrade to chokidar 3 with 15x less dependencies.

    npm WARN deprecated urix@0.1.0: Please see https://github.com/lydell/urix#deprecated

    npm WARN deprecated resolve-url@0.2.1: https://github.com/lydell/resolve-url#deprecated

    npm WARN deprecated fsevents@1.2.13: fsevents 1 will break on node v14+ and could be using insecure binaries. Upgrade to fsevents 2.

    npm WARN deprecated request-promise-native@1.0.9: request-promise-native has been deprecated because it extends the now deprecated request package, see https://github.com/request/request/issues/3142

    npm WARN deprecated request@2.88.2: request has been deprecated, see https://github.com/request/request/issues/3142

    npm WARN deprecated har-validator@5.1.5: this library is no longer supported

    npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@^2.1.2 (node_modules/jest-haste-map/node_modules/fsevents):

    npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

    npm WARN notsup Unsupported engine for watchpack-chokidar2@2.0.0: wanted: {"node":"<8.10.0"} (current: {"node":"14.7.0","npm":"6.14.7"})

    npm WARN notsup Not compatible with your version of node/npm: watchpack-chokidar2@2.0.0

    npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@^1.2.7 (node_modules/watchpack-chokidar2/node_modules/chokidar/node_modules/fsevents):

    npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@1.2.13: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

    npm WARN @rollup/plugin-commonjs@11.0.2 requires a peer of rollup@^1.20.0 but none is installed. You must install peer dependencies yourself.

    npm WARN @rollup/plugin-json@4.0.2 requires a peer of rollup@^1.20.0 but none is installed. You must install peer dependencies yourself.

    npm WARN @rollup/plugin-replace@2.3.1 requires a peer of rollup@^1.20.0 but none is installed. You must install peer dependencies yourself.

    npm WARN @rollup/plugin-node-resolve@7.1.1 requires a peer of rollup@^1.20.0 but none is installed. You must install peer dependencies yourself.

    npm WARN @rollup/plugin-alias@3.0.1 requires a peer of rollup@^1.20.0 but none is installed. You must install peer dependencies yourself.

    

    npm ERR! code E404

    npm ERR! 404 Not Found - GET https://registry.npmjs.org/@rollup/plugin-replace/-/plugin-replace-2.3.1.tgz

    npm ERR! 404 

    npm ERR! 404  '@rollup/plugin-replace@2.3.1' is not in the npm registry.

    npm ERR! 404 You should bug the author to publish it (or use the name yourself!)

    npm ERR! 404 It was specified as a dependency of 'repole0tq7th'

    npm ERR! 404 

    npm ERR! 404 Note that you can also install from a

    npm ERR! 404 tarball, folder, http url, or git url.

    

    npm ERR! A complete log of this run can be found in:

    npm ERR!     /home/jenkins/.npm/_logs/2020-08-06T09_02_33_456Z-debug.log

fisker Cheung commented 4 years ago

Thanks!

Alexander Akait · Answer 1 · Thu Aug 06 2020 18:28:21 GMT+0800 (China Standard Time)

We don't have pre-commit in this repo. How do you install prettier? We bundle prettier and when you run npm i prettier, no extra dependencies installed, using prettier from master branch is not a safe

Alexander Akait · Answer 2 · Thu Aug 06 2020 18:29:22 GMT+0800 (China Standard Time)

I think you have something wrong with your pre-commit configuration

Florent Chehab · Answer 3 · Thu Aug 06 2020 18:29:41 GMT+0800 (China Standard Time)

You do have support for pre-commit through this file: https://github.com/prettier/prettier/blob/master/.pre-commit-hooks.yaml

fisker Cheung · Answer 4 · Thu Aug 06 2020 18:56:21 GMT+0800 (China Standard Time)

I think this a good idea.

fisker Cheung · Answer 5 · Thu Aug 06 2020 19:21:16 GMT+0800 (China Standard Time)

Maybe we can just import https://github.com/awebdeveloper/pre-commit-prettier to prettier/pre-commit

Florent Chehab · Answer 6 · Thu Aug 06 2020 19:40:18 GMT+0800 (China Standard Time)

Maybe we can just import https://github.com/awebdeveloper/pre-commit-prettier to prettier/pre-commit

I think https://github.com/awebdeveloper/pre-commit-prettier setup is not ideal because the version handling is not "native".

You have to do:

  - repo: https://github.com/awebdeveloper/pre-commit-prettier
    rev: "master"
    hooks:
      - id: prettier
        additional_dependencies: ["prettier@2.0.5"]

What I am suggesting is a repo that follows the main repo in terms of tags / versions (at least for the releases to npm).

So that we could do:

  - repo: https://github.com/prettier/pre-commit
    rev: "2.0.5"
    hooks:
      - id: prettier

I can work on the repo (under a day, it should be pretty simple), and you shall decide if you integrate it in the prettier organization (I wouldn't want to take ownership of it personally).

Alexander Akait · Answer 7 · Thu Aug 06 2020 19:46:30 GMT+0800 (China Standard Time)

Just clarify, does pre-commit get https://github.com/prettier/prettier/blob/master/.pre-commit-hooks.yaml file automatically on installation?

fisker Cheung · Answer 8 · Thu Aug 06 2020 19:47:24 GMT+0800 (China Standard Time)

@evilebottnawi check this https://prettier.io/docs/en/precommit.html#option-3-pre-commithttpsgithubcompre-commitpre-commit

Alexander Akait · Answer 9 · Thu Aug 06 2020 19:51:31 GMT+0800 (China Standard Time)

oh, it is weird, why do not use packages npm register? It is not working with pre-commit?

fisker Cheung · Answer 10 · Thu Aug 06 2020 19:52:03 GMT+0800 (China Standard Time)

@FloChehab One off topic question, do you know is this change safe? Is it okay to remove files? Will it run on every file? None of us use pre-commit.

fisker Cheung · Answer 11 · Thu Aug 06 2020 19:55:01 GMT+0800 (China Standard Time)

oh, it is weird, why do not use packages npm register? It is not working with pre-commit?

I think I found something https://pre-commit.com/#node

Alexander Akait · Answer 12 · Thu Aug 06 2020 19:56:15 GMT+0800 (China Standard Time)

@fisker yep, I think we need to rewrite docs, because using master is really bad idea, it can be unstable between commits

Florent Chehab · Answer 13 · Thu Aug 06 2020 19:56:28 GMT+0800 (China Standard Time)

oh, it is weird, why do not use packages npm register? It is not working with pre-commit?

Unfortunately this is not the way pre-commit works, I am definitely not an expert of it, but from what I understand, it's only git based (which is pretty great for easy integration). I don't know if there is any plan on expanding the support to npm (or pip) directly.

Florent Chehab · Answer 14 · Thu Aug 06 2020 19:57:21 GMT+0800 (China Standard Time)

@FloChehab One off topic question, do you know is this change safe? Is it okay to remove files? Will it run on every file? None of us use pre-commit.

@fisker I'll have a look tonight ! :)

fisker Cheung · Answer 15 · Thu Aug 06 2020 19:58:14 GMT+0800 (China Standard Time)

@fisker I'll have a look tonight ! :)

Great appreciate!

Florent Chehab · Answer 16 · Thu Aug 06 2020 19:58:21 GMT+0800 (China Standard Time)

@fisker yep, I think we need to rewrite docs, because using master is really bad idea, it can be unstable between commits

Also, the main point of this issue, is actually that "old" tags are also unstable for pre-commit.

fisker Cheung · Answer 17 · Thu Aug 06 2020 20:02:42 GMT+0800 (China Standard Time)

I wonder if this the main reason we support install-from-github.

fisker Cheung · Answer 18 · Thu Aug 06 2020 20:14:20 GMT+0800 (China Standard Time)

Seems there is a tool for this https://github.com/pre-commit/pre-commit-mirror-maker

Florent Chehab · Answer 19 · Thu Aug 06 2020 20:23:17 GMT+0800 (China Standard Time)

Seems there is a tool for this https://github.com/pre-commit/pre-commit-mirror-maker

Nice ; so it should be even easier. At the end, I think the final repo should look like https://github.com/pre-commit/mirrors-jshint .

Florent Chehab · Answer 20 · Thu Aug 06 2020 20:26:57 GMT+0800 (China Standard Time)

So there might be discussions regarding under which github organization it might end up.

fisker Cheung · Answer 21 · Thu Aug 06 2020 20:33:14 GMT+0800 (China Standard Time)

I prefer it under @prettier, @evilebottnawi what do you think?

fisker Cheung · Answer 22 · Thu Aug 06 2020 20:47:20 GMT+0800 (China Standard Time)

I've created https://github.com/prettier/pre-commit

Alexander Akait · Answer 23 · Thu Aug 06 2020 21:06:12 GMT+0800 (China Standard Time)

make sense

Florent Chehab · Answer 24 · Thu Aug 06 2020 21:51:12 GMT+0800 (China Standard Time)

Thanks @fisker & @evilebottnawi for the fast action / decision making !

I'll test the new repo setup in few hours ; and I'll make feedbacks there.

fisker Cheung · Answer 25 · Thu Aug 06 2020 21:54:13 GMT+0800 (China Standard Time)

Let's keep this open, until prettier/pre-commit is stable and we can remove .pre-commit-hooks.yaml and update docs.

Let's move discuss to prettier/pre-commit#1

fisker Cheung · Answer 26 · Fri Aug 07 2020 16:33:14 GMT+0800 (China Standard Time)

I think I've done setting up https://github.com/prettier/pre-commit.

How do we notify people migrate to the new repo?

Something like this?

- id: prettier
  name: prettier
  entry: echo prettier support for pre-commit have been moved to https://github.com/prettier/pre-commit, please checkout the new repository. && exit 1

Florent Chehab · Answer 27 · Fri Aug 07 2020 17:06:04 GMT+0800 (China Standard Time)

You can go for:

      - id: prettier
        name: prettier
        entry: Prettier support for pre-commit have been moved to https://github.com/prettier/pre-commit, please checkout the new repository.
        language: fail
        pass_filenames: false

EDIT: added pass_filenames: false

fisker Cheung · Answer 28 · Fri Aug 07 2020 17:15:28 GMT+0800 (China Standard Time)

Thank you, I'll try.

fisker Cheung · Answer 29 · Fri Aug 07 2020 17:21:06 GMT+0800 (China Standard Time)

Great, it works, I tested on CI https://github.com/prettier/pre-commit/pull/6/checks?check_run_id=957631819#step:7:21

Do you want send a PR for this?

.pre-commit-hooks.yaml I used for test

Florent Chehab · Answer 30 · Fri Aug 07 2020 17:27:45 GMT+0800 (China Standard Time)

Sure, I'll do it ; we will need to also update prettier's documentation.