Properly deprecate types.string by infinisil · Pull Request #66346 · NixOS/nixpkgs

infinisil · 2019-08-08T21:26:06Z

Motivation for this change

For almost 6 (!) years now, types.string has been marked as deprecated in the comment above its definition. People keep using this type regardless, and it's getting annoying while reviewing PRs to constantly have to remind people to not use it.

This PR does following things:

Remove all usages of types.string in nixpkgs and replace them with a more appropriate type
Make types.string emit a warning upon use

The mass replacement was done all manually, because I needed to decide what the replacement type should be. This was either

types.str when merging doesn't make sense (e.g. user options)
types.separatedString " " if its an option representing command line arguments (ideally it should be listOf str for new modules)
types.lines if it's a line-based configuration format (where joining with newlines makes sense)
types.str if it's a different configuration format where concatenation doesn't work

Ping @Profpatsch @rycee @aanderse @danbst

Things done

I have not tested any of the modules. While there's a very low chance of any of these changes breaking anything, I might have made a mistake somewhere. A double-check would therefore be good.

Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)

rycee · 2019-08-08T22:05:26Z

Wonderful! I've recently been thinking about doing this exact thing since I see people accidentally using types.string in new modules all the time. It's a waste of energy to always have to look for and point this out when reviewing.

I'll make a proper review on the 12th 🙂

nixos/modules/programs/xss-lock.nix

nixos/modules/services/databases/couchdb.nix

nixos/modules/services/databases/openldap.nix

nixos/modules/services/logging/SystemdJournal2Gelf.nix

nixos/modules/services/mail/exim.nix

nixos/modules/services/misc/uhub.nix

nixos/modules/services/networking/charybdis.nix

nixos/modules/services/networking/gogoclient.nix

nixos/modules/services/networking/kippo.nix

nixos/modules/services/networking/prosody.nix

nixos/modules/services/networking/radicale.nix

nixos/modules/services/networking/softether.nix

nixos/modules/services/security/munge.nix

nixos/modules/services/security/oauth2_proxy.nix

nixos/modules/services/web-apps/youtrack.nix

nixos/modules/services/web-servers/uwsgi.nix

nixos/modules/services/web-servers/zope2.nix

Previously if `_file` was specified by a module: trace: warning: The type `types.string' of option `foo' defined in `/nix/store/yxhm2il5yrb92fldgriw0wyqh2kk9qyc-bug.nix' is deprecated. See NixOS/nixpkgs#66346 for better alternative types. With this change: trace: warning: The type `types.string' of option `foo' defined in `/home/infinisil/src/nixpkgs/bug.nix' is deprecated. See NixOS/nixpkgs#66346 for better alternative types.

see: NixOS/nixpkgs#66346 Use `types.str` when merging makes no sense (ie. "Hello" "World" shouln't become "HelloWorld"), `types.separatedString "${sep}"` when merging should be done (prefer `listOf str` though), and `types.lines` for line based configuration.

wkordalski · 2023-12-14T10:41:28Z

Even now https://nixos.wiki/wiki/Declaration informs that types.string is the right thing to use.
I don't know if this site is yours or not, but for sure a significant number of NixOS beginners learns there how to use mkOption.
Putting correct information there might help with the repeating types.string.

Mic92 · 2023-12-14T11:40:11Z

https://nixos.wiki/wiki/Declaration

Everyone can edit their, including you. I fixed it now.

types.string is deprecated. Related: NixOS/nixpkgs#66346

NixOS/nixpkgs#66346

see NixOS/nixpkgs#66346

NixOS/nixpkgs#66346

* NixOS/nixpkgs#66346

- as per NixOS/nixpkgs#66346 - also disabled gnome-keyring to use keepassxc secret agent instead

There is a deprecation warning, so act on it. ``` evaluation warning: The type `types.string` is deprecated. See NixOS/nixpkgs#66346 for better alternative types. ```

…kgs#66346

DaniD3v · 2025-05-23T07:27:35Z

types.separatedString " " if its an option representing command line arguments (ideally it should be listOf str for new modules)

Can you explain why listOf str should be used?

Should it be manually merged with " " in the config = {} section? Should we use apply in mkOptions?
Why is seperatedString even bad in the first place?

infinisil · 2025-05-23T12:13:13Z

@DaniD3v separatedString " " breaks passing of arguments with spaces, because concatStringsSep " " [ "foo bar" ] == concatStringsSep " " [ "foo" "bar" ]. It should be listOf str so that you can use lib.escapeShellArgs to turn it into a string that bash properly interprets :)

See NixOS/nixpkgs#66346

types.string is deprecated Viz. NixOS/nixpkgs#66346

- evaluation warning: In test `sensuclient': The `machine' attribute in NixOS tests (pkgs.nixosTest / make-test-python.nix / testing-python.nix / makeTest) is deprecated. Please set the equivalent `nodes.machine'. - evaluation warning: The type `types.string` is deprecated. See NixOS/nixpkgs#66346 for better alternative types. - evaluation warning: Module argument `nodes.host1.config` is deprecated. Use `nodes.host1` instead.

- evaluation warning: In test `sensuclient': The `machine' attribute in NixOS tests (pkgs.nixosTest / make-test-python.nix / testing-python.nix / makeTest) is deprecated. Please set the equivalent `nodes.machine'. - evaluation warning: The type `types.string` is deprecated. See NixOS/nixpkgs#66346 for better alternative types. - evaluation warning: Module argument `nodes.host1.config` is deprecated. Use `nodes.host1` instead. (cherry picked from commit 9267841)

infinisil requested review from edolstra and nbp as code owners August 8, 2019 21:26

infinisil changed the title ~~Remove types.string~~ Properly deprecate types.string Aug 8, 2019

infinisil mentioned this pull request Aug 9, 2019

openvswitch: better integration with systemd #53033

Merged

10 tasks