autodocodec-nix 0.1.0.2 → 0.1.1.0

raw patch · 4 files changed

+55/−5 lines, 4 filessetup-changedPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• CHANGELOG.md +11/−0
• Setup.hs +2/−0
• autodocodec-nix.cabal +2/−1
• src/Autodocodec/Nix/Options.hs +40/−4

@@ -1,5 +1,16 @@ # Changelog +## [0.1.1.0] - 2026-10-06++### Changed++* A comment on a field's codec, from `<?>` or `<??>`, now ends up in the+  generated option's `description` after the field's own description.+  It used to be dropped, so documentation written on a shared type's codec+  never reached the NixOS module generated from it.+  This includes a field built with `optionalFieldOrNullWith`, whose codec sits+  under the `EitherCodec` that `maybeCodec` is.+ ## [0.1.0.2] - 2026-07-14  ### Changed

@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain

@@ -5,7 +5,7 @@ -- see: https://github.com/sol/hpack  name:           autodocodec-nix-version:        0.1.0.2+version:        0.1.1.0 synopsis:       Autodocodec interpreters for nix homepage:       https://github.com/NorfairKing/autodocodec#readme bug-reports:    https://github.com/NorfairKing/autodocodec/issues@@ -33,6 +33,7 @@       Paths_autodocodec_nix   hs-source-dirs:       src+  ghc-options: -Wall -Wincomplete-uni-patterns -Wincomplete-record-updates -Wpartial-fields -Widentities -Wredundant-constraints -Wcpp-undef   build-depends:       aeson     , autodocodec >=0.6.0.0

@@ -141,7 +141,7 @@                     else id                 )                   $ valueCodecNixOptionType o,-              optionDescription = mDesc,+              optionDescription = optionDescriptionFor mDesc o,               optionDefault =                 if b                   then Just JSON.Null@@ -151,7 +151,7 @@         M.singleton key $           Option             { optionType = OptionTypeNullOr <$> valueCodecNixOptionType o,-              optionDescription = mDesc,+              optionDescription = optionDescriptionFor mDesc o,               optionDefault = Just JSON.Null -- [ref:NixOptionNullable]             }       OptionalKeyWithDefaultCodec key c defaultValue mDesc ->@@ -159,7 +159,7 @@           key           Option             { optionType = valueCodecNixOptionType c,-              optionDescription = mDesc,+              optionDescription = optionDescriptionFor mDesc c,               optionDefault = Just $ toJSONVia c defaultValue             }       OptionalKeyWithOmittedDefaultCodec key c defaultValue mDesc ->@@ -167,7 +167,7 @@           key           Option             { optionType = valueCodecNixOptionType c,-              optionDescription = mDesc,+              optionDescription = optionDescriptionFor mDesc c,               optionDefault = Just $ toJSONVia c defaultValue             }       PureCodec _ -> M.empty@@ -190,6 +190,42 @@               <$> optionType o1               <*> optionType o2         }++-- | What an option says about itself: the field's own description, and then+-- whatever comments the codec under it carries.+--+-- Both, because the two say the same kind of thing in two places. A field's+-- description is written where the field is and a comment is written where+-- the type is, and whoever reads the generated option wants what each of them+-- knows. Keeping only the description is how documentation written with+-- '<?>' silently fails to reach a NixOS module.+optionDescriptionFor :: Maybe Text -> ValueCodec input output -> Maybe Text+optionDescriptionFor mDesc c =+  case filter (not . T.null) $ map T.strip $ maybeToList mDesc ++ valueCodecComments c of+    [] -> Nothing+    ds -> Just $ T.intercalate "\n" ds++-- | The comments on a value codec, outermost first.+--+-- Through a 'BimapCodec' as 'valueCodecNixOptionType' is, because a codec+-- written for one type in terms of another is still that type's codec, and a+-- comment on the one underneath documents it.+--+-- Through the 'EitherCodec' that 'maybeCodec' is, for the same reason: a+-- codec made nullable is still that codec, and 'optionalFieldOrNullWith'+-- builds its field that way, so a comment there would otherwise be the one+-- kind that silently went missing.+--+-- Not into any other 'EitherCodec', nor into an 'ArrayOfCodec', whose+-- comments are about something the option is made of rather than about the+-- option.+valueCodecComments :: ValueCodec input output -> [Text]+valueCodecComments = \case+  CommentCodec comment c -> comment : valueCodecComments c+  BimapCodec _ _ c -> valueCodecComments c+  EitherCodec _ NullCodec c -> valueCodecComments c+  EitherCodec _ c NullCodec -> valueCodecComments c+  _ -> []  data Option = Option   { optionType :: !(Maybe OptionType),