prettier: Add official plugins #442943

S0AndS0 · 2025-09-14T16:36:24Z

Main intent is to provide Prettier plugins for PR #442463 to consume.

Prettier provides, at time of this commit, four official plugins. And there are about two dozen community plugins available too.

So it seems wise to leverage existing code, where possible, and follow examples provided by similar NPM projects that have been packaged with plugins.

Much of these changes are based on examples found from;

./pkgs/by-name/le/lessc/plugins/
./pkgs/development/node-packages/

... as well as documentation provided in;

./doc/languages-frameworks/javascript.section.md

Most of the changes from above references are under;

./pkgs/by-name/pr/prettier/plugins/aliases.nix, within the mapAliases call near end of file
./pkgs/by-name/pr/prettier/plugins/node-packages.json, which lists NPM package names
./pkgs/by-name/pr/prettier/package.nix, which updates doc-comment and adds passthru.plugins

... Other files were either copy/pasted, and slightly modified, or generated via the ./pkgs/by-name/pr/prettier/plugins/generate.sh script.

Things done

Add a 👍 reaction to pull requests you find important.

Edit 2025-09-14 16:41 UTC

Not sure what should be done about the linter error;

pkgs/by-name/pr/prettier: File plugins/composition.nix at line 4 contains the nix search path expression "" which may point outside the directory of that package.

... because the plugins/composition.nix file's first line clearly states # This file has been generated by node2nix 1.11.1. Do not edit!, so manually fixing things are likely to be undone by next person (or myself) who updates plugins via the generate.sh script.

The plugins/default.nix is passing/forwarding the attrs in, so manually removing the ? ... stuff shouldn't break anything.

Main intent is to provide Prettier plugins for PR NixOS#442463 to consume. Prettier provides, at time of this commit, four [official](https://prettier.io/docs/plugins/#official-plugins) plugins. And there are about two dozen [community](https://prettier.io/docs/plugins/#community-plugins) plugins available too. So it seems wise to leverage existing code, where possible, and follow examples provided by similar NPM projects that have been packaged with plugins. Much of these changes are based on examples found from; - `./pkgs/by-name/le/lessc/plugins/` - `./pkgs/development/node-packages/` ... as well as documentation provided in; - `./doc/languages-frameworks/javascript.section.md`

This _should_ be the final, for now, officially supported plugin from Prettier to be added via this patch-set.

⚠️ this will be a source of future maintenance friction.

l0b0 · 2025-10-31T16:01:54Z

pkgs/by-name/pr/prettier/plugins/composition.nix

+    inherit system;
+  },
+  system ? builtins.currentSystem,
+  nodejs ? pkgs."nodejs_22",


Nit: This shouldn't need quotes, because underscore is not a special character.

Top of that file says;

# This file has been generated by node2nix 1.11.1. Do not edit!

... I'll remove the quotes, but expect 'em to resurrect next time node2nix gets ideas ;-)

Ah, missed that. I'd just leave it in that case.

l0b0 · 2025-10-31T16:32:32Z

pkgs/by-name/pr/prettier/plugins/remove-attr.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env nix-shell


Is this file supposed to be included?

If I remember correctly node2nix blessed us with it, and doing a bit of vimgrep /remove-attr/ pkgs/by-name/pr/prettier/plugins/* exposes a note;

pkgs/by-name/pr/prettier/plugins/aliases.nix

### Deprecated aliases - for backward compatibility ### ### !!! NOTE !!! ### Use `./remove-attr.py [attrname]` in this directory to remove your alias ### from the `nodePackages` set without regenerating the entire file.

... I'm not sure if it needs to be included at this point 🤷

l0b0 · 2025-10-31T16:33:02Z

pkgs/by-name/pr/prettier/plugins/overrides.nix

@@ -0,0 +1,23 @@
+# Do not use overrides in this file to add  `meta.mainProgram` to packages. Use `./main-programs.nix`


Isn't this a no-op right now? If so, can we exclude it until it's needed?

It is loaded by pkgs/by-name/pr/prettier/plugins/default.nix;

extensions = composeManyExtensions [ aliases mainProgramOverrides (import ./overrides.nix { inherit pkgs nodejs; }) ];

... which I think was also generated by node2nix so, similar to removing other files it generates, it is likely to resurrect itself

OK, looks like all the extra code is node2nix's, let's just keep it if other reviewers agree. I'm not sure what the norm is.

pyrox0 · 2025-11-04T17:40:24Z

I would much rather this use the npm/yarn/pnpm tooling built into nixpkgs, as node2nix-generated files are generally more difficult to maintain. Can this PR use that instead?

S0AndS0 · 2025-11-08T23:09:59Z

I would much rather this use the npm/yarn/pnpm tooling built into nixpkgs, as node2nix-generated files are generally more difficult to maintain. Can this PR use that instead?

... Perhaps?... if ya can point me to the instructions, and it ain't too much trouble, I may be able to convert and after it looks good squash the Git-commit-churn ;-)

pyrox0 · 2025-11-08T23:11:59Z

I would much rather this use the npm/yarn/pnpm tooling built into nixpkgs, as node2nix-generated files are generally more difficult to maintain. Can this PR use that instead?

... Perhaps?... if ya can point me to the instructions, and it ain't too much trouble, I may be able to convert and after it looks good squash the Git-commit-churn ;-)

https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/javascript.section.md#buildnpmpackage-javascript-buildnpmpackage has the instructions for packages that rely on npm, and if you scroll down you'll see instructions for pnpm- and yarn-based packages.

S0AndS0 · 2025-11-09T00:37:56Z

... Perhaps?... if ya can point me to the instructions, and it ain't too much trouble, I may be able to convert and after it looks good squash the Git-commit-churn ;-)

https://github.com/NixOS/nixpkgs/blob/master/doc/languages-frameworks/javascript.section.md#buildnpmpackage-javascript-buildnpmpackage has the instructions for packages that rely on npm, and if you scroll down you'll see instructions for pnpm- and yarn-based packages.

Thanks!!!

Seems the Prettier main package provides a yarn.lock so I may lean towards that though, as it has been a bit and I made some questionable coding choices to inject plugins, it may take me a bit to catch-up to whatever my past self was thinkin' x-)

Edit; I've got issues, skill issues x-)

SyntaxError: Unknown token: { line: 3, col: 2, type: 'INVALID', value: undefined } 3:2 in lockfile

Tried copy/pastying the examples provided by javascript.section.md -> Yarn with something like;

let
  gitpkgs = import /home/s0ands0/git/hub/NixOS/nixpkgs/wt/prettier-plugins-official { };
in
{
  lib ? gitpkgs.lib,
  stdenv ? gitpkgs.stdenv,
  fetchFromGitHub ? gitpkgs.fetchFromGitHub,
  fetchYarnDeps ? gitpkgs.fetchYarnDeps,
  yarnConfigHook ? gitpkgs.yarnConfigHook,
  yarnBuildHook ? gitpkgs.yarnBuildHook,
  yarnInstallHook ? gitpkgs.yarnInstallHook,
  nodejs ? gitpkgs.nodejs,
  plugins ? [ ],
}:
stdenv.mkDerivation (finalAttrs: {
  pname = "prettier";
  version = "3.6.2";

  src = fetchFromGitHub {
    owner = "prettier";
    repo = "prettier";
    tag = finalAttrs.version;
    hash = "sha256-uMLRFBZP7/42R6nReONcb9/kVGCn3yGHLcLFajMZLmQ=";
  };

  yarnOfflineCache = fetchYarnDeps {
    yarnLock = finalAttrs.src + "/yarn.lock";
    hash = "";
  };

  nativeBuildInputs = [
    yarnConfigHook
    yarnBuildHook
    yarnInstallHook
    nodejs
  ];

  meta = {
    changelog = "https://github.com/prettier/prettier/blob/${finalAttrs.version}/CHANGELOG.md";
    description = "Code formatter";
    homepage = "https://prettier.io/";
    license = lib.licenses.mit;
    mainProgram = "prettier";
    maintainers = with lib.maintainers; [
      l0b0
      S0AndS0
    ];
  };
})

... but, running nix-build pkgs/by-name/pr/prettier/package.nix was no joy :-|

And checking the "Full logs" didn't illuminate why fetchYarnDeps ain't happy, just a stack trace that doesn't point to the full yarn.lock path it thinks its reading;

Running phase: patchPhase
@nix { "action": "setPhase", "phase": "patchPhase" }
Running phase: updateAutotoolsGnuConfigScriptsPhase
@nix { "action": "setPhase", "phase": "updateAutotoolsGnuConfigScriptsPhase" }
Running phase: configurePhase
@nix { "action": "setPhase", "phase": "configurePhase" }
no configure script, doing nothing
Running phase: buildPhase
@nix { "action": "setPhase", "phase": "buildPhase" }
SyntaxError: Unknown token: { line: 3, col: 2, type: 'INVALID', value: undefined } 3:2 in lockfile
    at Parser.unexpected (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/yarnpkg-lockfile.js:5064:11)
    at Parser.parse (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/yarnpkg-lockfile.js:5193:14)
    at parse (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/yarnpkg-lockfile.js:5262:17)
    at module.exports.exports.default (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/yarnpkg-lockfile.js:4835:96)
    at prefetchYarnDeps (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/index.js:159:29)
    at main (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/index.js:204:11)

I like the idea of yarn, especially if it acktually reduces the grossness needed to inject plugins, but at this point I kinda prefer something that works; even if it lurches x-)

pyrox0 · 2025-11-09T18:58:21Z

... Perhaps?... if ya can point me to the instructions, and it ain't too much trouble, I may be able to convert and after it looks good squash the Git-commit-churn ;-)

master/doc/languages-frameworks/javascript.section.md#buildnpmpackage-javascript-buildnpmpackage has the instructions for packages that rely on npm, and if you scroll down you'll see instructions for pnpm- and yarn-based packages.

Thanks!!!

Seems the Prettier main package provides a yarn.lock so I may lean towards that though, as it has been a bit and I made some questionable coding choices to inject plugins, it may take me a bit to catch-up to whatever my past self was thinkin' x-)

Edit; I've got issues, skill issues x-)

SyntaxError: Unknown token: { line: 3, col: 2, type: 'INVALID', value: undefined } 3:2 in lockfile

Tried copy/pastying the examples provided by javascript.section.md -> Yarn with something like;
let
  gitpkgs = import /home/s0ands0/git/hub/NixOS/nixpkgs/wt/prettier-plugins-official { };
in
{
  lib ? gitpkgs.lib,
  stdenv ? gitpkgs.stdenv,
  fetchFromGitHub ? gitpkgs.fetchFromGitHub,
  fetchYarnDeps ? gitpkgs.fetchYarnDeps,
  yarnConfigHook ? gitpkgs.yarnConfigHook,
  yarnBuildHook ? gitpkgs.yarnBuildHook,
  yarnInstallHook ? gitpkgs.yarnInstallHook,
  nodejs ? gitpkgs.nodejs,
  plugins ? [ ],
}:
stdenv.mkDerivation (finalAttrs: {
  pname = "prettier";
  version = "3.6.2";

  src = fetchFromGitHub {
    owner = "prettier";
    repo = "prettier";
    tag = finalAttrs.version;
    hash = "sha256-uMLRFBZP7/42R6nReONcb9/kVGCn3yGHLcLFajMZLmQ=";
  };

  yarnOfflineCache = fetchYarnDeps {
    yarnLock = finalAttrs.src + "/yarn.lock";
    hash = "";
  };

  nativeBuildInputs = [
    yarnConfigHook
    yarnBuildHook
    yarnInstallHook
    nodejs
  ];

  meta = {
    changelog = "https://github.com/prettier/prettier/blob/${finalAttrs.version}/CHANGELOG.md";
    description = "Code formatter";
    homepage = "https://prettier.io/";
    license = lib.licenses.mit;
    mainProgram = "prettier";
    maintainers = with lib.maintainers; [
      l0b0
      S0AndS0
    ];
  };
})
... but, running nix-build pkgs/by-name/pr/prettier/package.nix was no joy :-|

And checking the "Full logs" didn't illuminate why fetchYarnDeps ain't happy, just a stack trace that doesn't point to the full yarn.lock path it thinks its reading;
Running phase: patchPhase
@nix { "action": "setPhase", "phase": "patchPhase" }
Running phase: updateAutotoolsGnuConfigScriptsPhase
@nix { "action": "setPhase", "phase": "updateAutotoolsGnuConfigScriptsPhase" }
Running phase: configurePhase
@nix { "action": "setPhase", "phase": "configurePhase" }
no configure script, doing nothing
Running phase: buildPhase
@nix { "action": "setPhase", "phase": "buildPhase" }
SyntaxError: Unknown token: { line: 3, col: 2, type: 'INVALID', value: undefined } 3:2 in lockfile
    at Parser.unexpected (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/yarnpkg-lockfile.js:5064:11)
    at Parser.parse (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/yarnpkg-lockfile.js:5193:14)
    at parse (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/yarnpkg-lockfile.js:5262:17)
    at module.exports.exports.default (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/yarnpkg-lockfile.js:4835:96)
    at prefetchYarnDeps (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/index.js:159:29)
    at main (/nix/store/afvd0gfvjr417337rsya4ixqh3w9vj5l-prefetch-yarn-deps/libexec/index.js:204:11)
I like the idea of yarn, especially if it acktually reduces the grossness needed to inject plugins, but at this point I kinda prefer something that works; even if it lurches x-)

Prettier uses yarn berry, so you want to scroll down to the Yarn Berry section below that and use that instead. You'll have to provide your own buildPhase and installPhase but otherwise should be similar.

S0AndS0 added 5 commits September 14, 2025 09:16

prettier-plugin-ruby: init at 4.0.4

3b3e009

prettier-plugin-pug: init at 3.4.2

d73d6cd

prettier-plugin-php: init at 0.24.0

fa836af

This _should_ be the final, for now, officially supported plugin from Prettier to be added via this patch-set.

prettier: Update top-level doc-comment

ccf10b7

nixpkgs-ci bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels Sep 14, 2025

prettier: delete impure import in composition.nix

6538e98

⚠️ this will be a source of future maintenance friction.

nixpkgs-ci bot added the 9.needs: reviewer This PR currently has no reviewers requested and needs attention. label Sep 14, 2025

oneingan mentioned this pull request Oct 4, 2025

Fix prettier divnix/std#419

Open

oneingan requested a review from l0b0 October 31, 2025 10:30

nixpkgs-ci bot removed the 9.needs: reviewer This PR currently has no reviewers requested and needs attention. label Oct 31, 2025

l0b0 reviewed Oct 31, 2025

View reviewed changes

l0b0 approved these changes Nov 1, 2025

View reviewed changes

nixpkgs-ci bot added the 12.approvals: 1 This PR was reviewed and approved by one person. label Nov 1, 2025

		@@ -0,0 +1,23 @@
		# Do not use overrides in this file to add `meta.mainProgram` to packages. Use `./main-programs.nix`

Uh oh!

prettier: Add official plugins #442943

Are you sure you want to change the base?

prettier: Add official plugins #442943

Uh oh!

Conversation

S0AndS0 commented Sep 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Things done

Edit 2025-09-14 16:41 UTC

Uh oh!

l0b0 Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

S0AndS0 Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

l0b0 Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

l0b0 Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

S0AndS0 Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

l0b0 Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

S0AndS0 Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

l0b0 Nov 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pyrox0 commented Nov 4, 2025

Uh oh!

S0AndS0 commented Nov 8, 2025

Uh oh!

pyrox0 commented Nov 8, 2025

Uh oh!

S0AndS0 commented Nov 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pyrox0 commented Nov 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

S0AndS0 commented Sep 14, 2025 •

edited

Loading

l0b0 Nov 1, 2025 •

edited

Loading

S0AndS0 commented Nov 9, 2025 •

edited

Loading

pyrox0 commented Nov 9, 2025 •

edited

Loading