TITLE

Provide zef compatible meta-data for Rakudo


SUBTITLE

data

=begin data
{"type":"page","file":"work_mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/README.md","sources":[],"node":{"type":"block","id":"01eyVSCFeGGy-_4JvlmeG","margin":"","name":"root","content":[{"type":"para","id":"aCJU2UHOAATm35YfePBmc","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":141,"offset":140}},"text":"text","content":[{"meta":"https://github.com/lizmat/Rakudo-CORE-META/actions","type":"fcode","name":"L","content":[{"type":"block","id":"8caDRvxi5IQEemqdsIq4a","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":88,"offset":87}},"content":[{"type":"image","src":"https://github.com/lizmat/Rakudo-CORE-META/workflows/test/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"rP6xg5AFHAlVBlFtznaBa","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":142},"end":{"line":4,"column":5,"offset":151}},"content":["NAME"]},{"type":"para","id":"iQYP32YMcBXSSIMz8QS0v","margin":"","location":{"start":{"line":6,"column":1,"offset":153},"end":{"line":6,"column":65,"offset":217}},"text":"text","content":["Rakudo::CORE::META - Provide zef compatible meta-data for Rakudo"]},{"type":"block","id":"Pb1VqlftgnlNHrVo_mV_u","margin":"","level":1,"name":"head","location":{"start":{"line":8,"column":1,"offset":219},"end":{"line":9,"column":9,"offset":236}},"content":["SYNOPSIS"]},{"type":"block","id":"c7gQh5FQ1CLB-PuyQZ9pS","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":11,"column":1,"offset":238},"end":{"line":15,"column":4,"offset":383}},"content":[{"type":"verbatim","value":"use Rakudo::CORE::META;\nsay \"Rakudo core provides these additional modules:\";\n.say for %Rakudo::CORE::META<provides>.keys.sort(*.fc);"}]},{"type":"block","id":"pGjSA2kynfHyf3fXq8xPH","margin":"","level":1,"name":"head","location":{"start":{"line":17,"column":1,"offset":385},"end":{"line":18,"column":12,"offset":408}},"content":["DESCRIPTION"]},{"type":"para","id":"EKpBQVl-RG_4rm6XDyOic","margin":"","location":{"start":{"line":20,"column":1,"offset":410},"end":{"line":20,"column":274,"offset":683}},"text":"text","content":["Rakudo::CORE::META provides zef compatible meta-data of the modules that are provided by the Rakudo core, by exporting ",{"type":"fcode","name":"C","content":["%Rakudo::CORE::META"]}," hash. This hash contains information that could be introspected at installation time of the module, or after any Rakudo core update."]},{"type":"block","id":"sC1BuPWC-YahN_HwaKMKe","margin":"","level":1,"name":"head","location":{"start":{"line":22,"column":1,"offset":685},"end":{"line":23,"column":7,"offset":698}},"content":["AUTHOR"]},{"type":"para","id":"g5A0zGgAeoYhbnB5HG1IJ","margin":"","location":{"start":{"line":25,"column":1,"offset":700},"end":{"line":25,"column":37,"offset":736}},"text":"text","content":["Elizabeth Mattijsen ",{"meta":"mailto:liz@raku.rocks","type":"fcode","name":"L","content":["liz@raku.rocks"]}]},{"type":"block","id":"lKTIcS33nr05F7nibYL-T","margin":"","level":1,"name":"head","location":{"start":{"line":27,"column":1,"offset":738},"end":{"line":28,"column":22,"offset":781}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"zMN4ohkSEpCr2gXbjRPjf","margin":"","location":{"start":{"line":30,"column":1,"offset":783},"end":{"line":30,"column":35,"offset":817}},"text":"text","content":["Copyright 2021 Elizabeth Mattijsen"]},{"type":"para","id":"Pf8XZpTQGuUhuNG3_WUAQ","margin":"","location":{"start":{"line":32,"column":1,"offset":819},"end":{"line":32,"column":111,"offset":929}},"text":"text","content":["Source can be located at: ",{"meta":"https://github.com/lizmat/Rakudo-CORE-META","type":"fcode","name":"L","content":["https://github.com/lizmat/Rakudo-CORE-META"]}," . Comments and Pull Requests are welcome."]},{"type":"para","id":"zeLomyH0vfduWu3gut7Q4","margin":"","location":{"start":{"line":34,"column":1,"offset":931},"end":{"line":34,"column":104,"offset":1034}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:lizmat","authors":["Elizabeth Mattijsen"],"build-depends":[],"depends":[],"description":"Provide zef compatible meta-data for Rakudo","dist":"Rakudo::CORE::META:ver<0.0.3>:auth<zef:lizmat>","license":"Artistic-2.0","name":"Rakudo::CORE::META","path":"R/AK/RAKUDO_CORE_META/a288b24b6cb460e195ab37584dc7b9f33c36bdc1.tar.gz","perl":"6.d","provides":{"Rakudo::CORE::META":"lib/Rakudo/CORE/META.rakumod"},"resources":[],"source-url":"https://github.com/lizmat/Rakudo-CORE-META.git","tags":[],"test-depends":[],"version":"0.0.3"},"files":[{"file":"work_mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/README.md","publishUrl":"/mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/README.md"},{"file":"work_mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/lib/Rakudo/CORE/META.rakumod","publishUrl":"/mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/lib/Rakudo/CORE/META.rakumod"}],"src":"zef","url":"/mods/zef/Rakudo::CORE::META"}}}
=end data


React

    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/README.md","sources":[],"node":{"type":"block","id":"01eyVSCFeGGy-_4JvlmeG","margin":"","name":"root","content":[{"type":"para","id":"aCJU2UHOAATm35YfePBmc","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":141,"offset":140}},"text":"text","content":[{"meta":"https://github.com/lizmat/Rakudo-CORE-META/actions","type":"fcode","name":"L","content":[{"type":"block","id":"8caDRvxi5IQEemqdsIq4a","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":88,"offset":87}},"content":[{"type":"image","src":"https://github.com/lizmat/Rakudo-CORE-META/workflows/test/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"rP6xg5AFHAlVBlFtznaBa","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":142},"end":{"line":4,"column":5,"offset":151}},"content":["NAME"]},{"type":"para","id":"iQYP32YMcBXSSIMz8QS0v","margin":"","location":{"start":{"line":6,"column":1,"offset":153},"end":{"line":6,"column":65,"offset":217}},"text":"text","content":["Rakudo::CORE::META - Provide zef compatible meta-data for Rakudo"]},{"type":"block","id":"Pb1VqlftgnlNHrVo_mV_u","margin":"","level":1,"name":"head","location":{"start":{"line":8,"column":1,"offset":219},"end":{"line":9,"column":9,"offset":236}},"content":["SYNOPSIS"]},{"type":"block","id":"c7gQh5FQ1CLB-PuyQZ9pS","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":11,"column":1,"offset":238},"end":{"line":15,"column":4,"offset":383}},"content":[{"type":"verbatim","value":"use Rakudo::CORE::META;\nsay \"Rakudo core provides these additional modules:\";\n.say for %Rakudo::CORE::META<provides>.keys.sort(*.fc);"}]},{"type":"block","id":"pGjSA2kynfHyf3fXq8xPH","margin":"","level":1,"name":"head","location":{"start":{"line":17,"column":1,"offset":385},"end":{"line":18,"column":12,"offset":408}},"content":["DESCRIPTION"]},{"type":"para","id":"EKpBQVl-RG_4rm6XDyOic","margin":"","location":{"start":{"line":20,"column":1,"offset":410},"end":{"line":20,"column":274,"offset":683}},"text":"text","content":["Rakudo::CORE::META provides zef compatible meta-data of the modules that are provided by the Rakudo core, by exporting ",{"type":"fcode","name":"C","content":["%Rakudo::CORE::META"]}," hash. This hash contains information that could be introspected at installation time of the module, or after any Rakudo core update."]},{"type":"block","id":"sC1BuPWC-YahN_HwaKMKe","margin":"","level":1,"name":"head","location":{"start":{"line":22,"column":1,"offset":685},"end":{"line":23,"column":7,"offset":698}},"content":["AUTHOR"]},{"type":"para","id":"g5A0zGgAeoYhbnB5HG1IJ","margin":"","location":{"start":{"line":25,"column":1,"offset":700},"end":{"line":25,"column":37,"offset":736}},"text":"text","content":["Elizabeth Mattijsen ",{"meta":"mailto:liz@raku.rocks","type":"fcode","name":"L","content":["liz@raku.rocks"]}]},{"type":"block","id":"lKTIcS33nr05F7nibYL-T","margin":"","level":1,"name":"head","location":{"start":{"line":27,"column":1,"offset":738},"end":{"line":28,"column":22,"offset":781}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"zMN4ohkSEpCr2gXbjRPjf","margin":"","location":{"start":{"line":30,"column":1,"offset":783},"end":{"line":30,"column":35,"offset":817}},"text":"text","content":["Copyright 2021 Elizabeth Mattijsen"]},{"type":"para","id":"Pf8XZpTQGuUhuNG3_WUAQ","margin":"","location":{"start":{"line":32,"column":1,"offset":819},"end":{"line":32,"column":111,"offset":929}},"text":"text","content":["Source can be located at: ",{"meta":"https://github.com/lizmat/Rakudo-CORE-META","type":"fcode","name":"L","content":["https://github.com/lizmat/Rakudo-CORE-META"]}," . Comments and Pull Requests are welcome."]},{"type":"para","id":"zeLomyH0vfduWu3gut7Q4","margin":"","location":{"start":{"line":34,"column":1,"offset":931},"end":{"line":34,"column":104,"offset":1034}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:lizmat","authors":["Elizabeth Mattijsen"],"build-depends":[],"depends":[],"description":"Provide zef compatible meta-data for Rakudo","dist":"Rakudo::CORE::META:ver<0.0.3>:auth<zef:lizmat>","license":"Artistic-2.0","name":"Rakudo::CORE::META","path":"R/AK/RAKUDO_CORE_META/a288b24b6cb460e195ab37584dc7b9f33c36bdc1.tar.gz","perl":"6.d","provides":{"Rakudo::CORE::META":"lib/Rakudo/CORE/META.rakumod"},"resources":[],"source-url":"https://github.com/lizmat/Rakudo-CORE-META.git","tags":[],"test-depends":[],"version":"0.0.3"},"files":[{"file":"work_mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/README.md","publishUrl":"/mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/README.md"},{"file":"work_mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/lib/Rakudo/CORE/META.rakumod","publishUrl":"/mods/zef/Rakudo::CORE::META/Rakudo-CORE-META-0.0.3/lib/Rakudo/CORE/META.rakumod"}],"src":"zef","url":"/mods/zef/Rakudo::CORE::META"}}}
    =end data
    =end React


root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

Rakudo::CORE::META


Rakudo Command Line Options


Rakudo::Options


Get config files that are Raku structures


=begin data
{"type":"page","file":"work_mods/zef/RakuConfig/dist/README.md","sources":[],"node":{"type":"block","id":"pWQoCF8-kWHsU9OmXRXvL","margin":"","name":"root","content":[{"type":"para","id":"6G6Yo3d2BhPdXxzQneo0l","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":111,"offset":110}},"text":"text","content":[{"type":"block","id":"3yoa8a2Y8_8csYS6vrve5","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":111,"offset":110}},"content":[{"type":"image","src":"https://github.com/finanalyst/raku-config/actions/workflows/test.yaml/badge.svg","alt":"github-tests-passing-badge"}]}]},{"type":"block","id":"s6agpu-3V1tZWShr1GFGv","margin":"","level":1,"name":"head","location":{"start":{"line":2,"column":1,"offset":111},"end":{"line":2,"column":20,"offset":130}},"content":["Raku Config files"]},{"type":"block","id":"MAeEAXUm8X2h6D434vqGF","margin":"","name":"nested","location":{"start":{"line":3,"column":1,"offset":131},"end":{"line":3,"column":47,"offset":177}},"content":[{"type":"para","id":"hLZD24X3wshiIbBafmOuP","margin":"","location":{"start":{"line":3,"column":2,"offset":132},"end":{"line":3,"column":47,"offset":177}},"text":"text","content":["Using Raku code to write configuration files."]}]},{"type":"block","id":"UJH5FJjJBI2VXvMKChSvr","margin":"","name":"nested","location":{"start":{"line":6,"column":1,"offset":180},"end":{"line":6,"column":48,"offset":227}},"content":[{"type":"para","id":"jEMt-Ps8pxtDCt35O7-WQ","margin":"","location":{"start":{"line":6,"column":3,"offset":182},"end":{"line":6,"column":48,"offset":227}},"text":"text","content":[{"type":"fcode","name":"B","content":["Author"]}," Richard Hainsworth, aka finanalyst"]}]},{"type":"block","id":"pUnsfEXDbnjWgb698vJs6","margin":"","level":2,"name":"head","location":{"start":{"line":10,"column":1,"offset":235},"end":{"line":10,"column":21,"offset":255}},"content":["Table of Contents"]},{"type":"para","id":"oOHx5FCV6IpUMXHtL-NFT","margin":"","location":{"start":{"line":11,"column":1,"offset":256},"end":{"line":16,"column":22,"offset":463}},"text":"text","content":[{"meta":"#license","type":"fcode","name":"L","content":["License"]},{"meta":"#purpose","type":"fcode","name":"L","content":["Purpose"]},{"meta":"#installation-and-use","type":"fcode","name":"L","content":["Installation and use"]},{"meta":"#subs-only-one-sub-is-exported","type":"fcode","name":"L","content":["Subs Only one sub is exported"]},{"meta":"#get-config","type":"fcode","name":"L","content":["get-config"]},{"meta":"#testing","type":"fcode","name":"L","content":["Testing"]}]},{"type":"block","id":"7RIlTpXxDRjKK7z_PRkOG","margin":"","level":1,"name":"head","location":{"start":{"line":19,"column":1,"offset":470},"end":{"line":19,"column":10,"offset":479}},"content":["LICENSE"]},{"type":"para","id":"mOBQZmiqXPsQoW1OWKKCH","margin":"","location":{"start":{"line":21,"column":1,"offset":481},"end":{"line":21,"column":9,"offset":489}},"text":"text","content":["Artist 2"]},{"type":"block","id":"cypnF-tFG-mEoZG-thTJr","margin":"","level":1,"name":"head","location":{"start":{"line":23,"column":1,"offset":491},"end":{"line":23,"column":10,"offset":500}},"content":["Purpose"]},{"type":"para","id":"KorS9pAWrDansTje93Tlp","margin":"","location":{"start":{"line":24,"column":1,"offset":501},"end":{"line":24,"column":216,"offset":716}},"text":"text","content":["Lots of modules need configuration files. Many Raku modules use JSON, or YAML. But neither YAML nor JSON is not Raku, and a configuration file has to be brought in and assigned to a data structure, typically a HASH."]},{"type":"para","id":"3gr4l1Yl9DF-9tXKKLB8r","margin":"","location":{"start":{"line":26,"column":1,"offset":718},"end":{"line":26,"column":96,"offset":813}},"text":"text","content":["But writing JSON or YAML means memorising the syntax of that language, then mapping it to Raku."]},{"type":"para","id":"BqZLKP4d5-xY7BnS48sCE","margin":"","location":{"start":{"line":28,"column":1,"offset":815},"end":{"line":28,"column":83,"offset":897}},"text":"text","content":["So, why not simply write the file in Raku and use EVALFILE to assign it to a Hash?"]},{"type":"para","id":"ZYb-cufOklSw1hrtWXuoJ","margin":"","location":{"start":{"line":30,"column":1,"offset":899},"end":{"line":30,"column":84,"offset":982}},"text":"text","content":["This module uses that idea, but allows for the configuration module to be anywhere."]},{"type":"para","id":"f52ebXgqEHAwpVR3pKTdE","margin":"","location":{"start":{"line":32,"column":1,"offset":984},"end":{"line":32,"column":148,"offset":1131}},"text":"text","content":["When reading in a configuration file, any Raku code is possible, so configuration files can look at Environment variables, or slurp in local files."]},{"type":"para","id":"QOoCJ0tV1uy0ssGCQKnxX","margin":"","location":{"start":{"line":34,"column":1,"offset":1133},"end":{"line":34,"column":160,"offset":1292}},"text":"text","content":["When writing a configuration file, there are many caveats relating to what can be serialised, but for static data, not closures, writing a config file is easy."]},{"type":"block","id":"RmaAYNEVbgz_RdB3HVRb3","margin":"","level":1,"name":"head","location":{"start":{"line":36,"column":1,"offset":1294},"end":{"line":36,"column":23,"offset":1316}},"content":["Installation and use"]},{"type":"para","id":"3y2GzSPe2r9wNNGUeUQqd","margin":"","location":{"start":{"line":37,"column":1,"offset":1317},"end":{"line":37,"column":7,"offset":1323}},"text":"text","content":["Simply"]},{"type":"block","id":"iGPB__GjoSh2kVWwlOV3S","margin":"","name":"code","config":[],"location":{"start":{"line":39,"column":1,"offset":1325},"end":{"line":41,"column":4,"offset":1355}},"content":[{"type":"verbatim","value":"zef install RakuConfig"}]},{"type":"para","id":"svGFjYrinuy3NaY7Zne9n","margin":"","location":{"start":{"line":42,"column":1,"offset":1356},"end":{"line":42,"column":5,"offset":1360}},"text":"text","content":["then"]},{"type":"block","id":"6bJoLL3lxUPqbfVmLSWPH","margin":"","name":"code","config":[],"location":{"start":{"line":44,"column":1,"offset":1362},"end":{"line":53,"column":4,"offset":1732}},"content":[{"type":"verbatim","value":"use RakuConfig;\nmy %config = get-config;\n# assumes that 'config.raku' exists in the current directory.\nmy %big-config = get-config( 'config-files' );\n# assumes multiple files of the for config-files/*.raku\n# files are evaluated in lexical order\n# detects whether keys in one file overwrite a previously set key\n# throws an Exception if an overwrite is attempted."}]},{"type":"block","id":"I8HrLW_iu884Euh_3IyUv","margin":"","level":1,"name":"head","location":{"start":{"line":54,"column":1,"offset":1733},"end":{"line":54,"column":32,"offset":1764}},"content":["Subs Only one sub is exported"]},{"type":"block","id":"vt0Ly9YPN2TEyLxwMx-tT","margin":"","level":2,"name":"head","location":{"start":{"line":55,"column":1,"offset":1765},"end":{"line":55,"column":14,"offset":1778}},"content":["get-config"]},{"type":"block","id":"OHCtr0oczsJhgOA_suvM0","margin":"","name":"code","config":[],"location":{"start":{"line":56,"column":1,"offset":1779},"end":{"line":64,"column":4,"offset":2266}},"content":[{"type":"verbatim","value":"#| :path is an existing file, or a current directory,\n#| if a directory, it should contain .raku files\n#| :required are the keys needed in a config after all .raku files are evaluated\n#| If :required is not given, or empty, no keys will be tested for existence\n#| With no parameters, the file 'config.raku' in the current directory is assumed\n#| Previous value of config is not used when :no-cache(True)\nmulti sub get-config(:$path = 'config.raku', :@required, :no-cache = False)"}]},{"type":"block","id":"XWGTSUCHYGR0GoAKaqsZB","margin":"","level":1,"name":"head","location":{"start":{"line":65,"column":1,"offset":2267},"end":{"line":65,"column":10,"offset":2276}},"content":["Testing"]},{"type":"para","id":"YYPmGCJbhzpAS6BhaBmh7","margin":"","location":{"start":{"line":66,"column":1,"offset":2277},"end":{"line":66,"column":214,"offset":2490}},"text":"text","content":["To reduce testing and installation hassle, the following have been removed from Test-depends: 'Test::META', 'Test::Deeply::Relaxed', 'File::Directory::Tree'\". They will need to be installed to prove the xt/ tests."]},{"type":"para","id":"8tLZC-ONEg6Jod8Ob88-f","margin":"","location":{"start":{"line":75,"column":1,"offset":2503},"end":{"line":75,"column":45,"offset":2547}},"text":"text","content":["Rendered from README at 2022-07-08T22:50:54Z"]}]},"publishUrl":"/mods/zef/RakuConfig/dist/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:finanalyst","authors":["Richard Hainsworth"],"build-depends":[],"depends":[],"description":"Get config files that are Raku structures","dist":"RakuConfig:ver<0.3.1>:auth<zef:finanalyst>","license":"Artistic-2.0","name":"RakuConfig","path":"R/AK/RAKUCONFIG/25a774f206e62fa738bf17cbe57a938a255ec51c.tar.gz","perl":"6.d","provides":{"RakuConfig":"lib/RakuConfig.pm6"},"resources":[],"source-type":"git","source-url":"git://github.com/finanalyst/raku-config.git","support":{"bugtracker":"https://github.com/finanalyst/raku-config/issues","email":"richard@hainsworth.wales","source":"https://github.com/finanalyst/raku-config.git"},"test-depends":[],"version":"0.3.1"},"files":[{"file":"work_mods/zef/RakuConfig/dist/README.md","publishUrl":"/mods/zef/RakuConfig/dist/README.md"},{"file":"work_mods/zef/RakuConfig/dist/CHANGELOG.md","publishUrl":"/mods/zef/RakuConfig/dist/CHANGELOG.md"},{"file":"work_mods/zef/RakuConfig/dist/CHANGELOG.pod6","publishUrl":"/mods/zef/RakuConfig/dist/CHANGELOG.pod6"},{"file":"work_mods/zef/RakuConfig/dist/README.pod6","publishUrl":"/mods/zef/RakuConfig/dist/README.pod6"}],"src":"zef","url":"/mods/zef/RakuConfig"}}}
=end data


    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/RakuConfig/dist/README.md","sources":[],"node":{"type":"block","id":"pWQoCF8-kWHsU9OmXRXvL","margin":"","name":"root","content":[{"type":"para","id":"6G6Yo3d2BhPdXxzQneo0l","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":111,"offset":110}},"text":"text","content":[{"type":"block","id":"3yoa8a2Y8_8csYS6vrve5","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":111,"offset":110}},"content":[{"type":"image","src":"https://github.com/finanalyst/raku-config/actions/workflows/test.yaml/badge.svg","alt":"github-tests-passing-badge"}]}]},{"type":"block","id":"s6agpu-3V1tZWShr1GFGv","margin":"","level":1,"name":"head","location":{"start":{"line":2,"column":1,"offset":111},"end":{"line":2,"column":20,"offset":130}},"content":["Raku Config files"]},{"type":"block","id":"MAeEAXUm8X2h6D434vqGF","margin":"","name":"nested","location":{"start":{"line":3,"column":1,"offset":131},"end":{"line":3,"column":47,"offset":177}},"content":[{"type":"para","id":"hLZD24X3wshiIbBafmOuP","margin":"","location":{"start":{"line":3,"column":2,"offset":132},"end":{"line":3,"column":47,"offset":177}},"text":"text","content":["Using Raku code to write configuration files."]}]},{"type":"block","id":"UJH5FJjJBI2VXvMKChSvr","margin":"","name":"nested","location":{"start":{"line":6,"column":1,"offset":180},"end":{"line":6,"column":48,"offset":227}},"content":[{"type":"para","id":"jEMt-Ps8pxtDCt35O7-WQ","margin":"","location":{"start":{"line":6,"column":3,"offset":182},"end":{"line":6,"column":48,"offset":227}},"text":"text","content":[{"type":"fcode","name":"B","content":["Author"]}," Richard Hainsworth, aka finanalyst"]}]},{"type":"block","id":"pUnsfEXDbnjWgb698vJs6","margin":"","level":2,"name":"head","location":{"start":{"line":10,"column":1,"offset":235},"end":{"line":10,"column":21,"offset":255}},"content":["Table of Contents"]},{"type":"para","id":"oOHx5FCV6IpUMXHtL-NFT","margin":"","location":{"start":{"line":11,"column":1,"offset":256},"end":{"line":16,"column":22,"offset":463}},"text":"text","content":[{"meta":"#license","type":"fcode","name":"L","content":["License"]},{"meta":"#purpose","type":"fcode","name":"L","content":["Purpose"]},{"meta":"#installation-and-use","type":"fcode","name":"L","content":["Installation and use"]},{"meta":"#subs-only-one-sub-is-exported","type":"fcode","name":"L","content":["Subs Only one sub is exported"]},{"meta":"#get-config","type":"fcode","name":"L","content":["get-config"]},{"meta":"#testing","type":"fcode","name":"L","content":["Testing"]}]},{"type":"block","id":"7RIlTpXxDRjKK7z_PRkOG","margin":"","level":1,"name":"head","location":{"start":{"line":19,"column":1,"offset":470},"end":{"line":19,"column":10,"offset":479}},"content":["LICENSE"]},{"type":"para","id":"mOBQZmiqXPsQoW1OWKKCH","margin":"","location":{"start":{"line":21,"column":1,"offset":481},"end":{"line":21,"column":9,"offset":489}},"text":"text","content":["Artist 2"]},{"type":"block","id":"cypnF-tFG-mEoZG-thTJr","margin":"","level":1,"name":"head","location":{"start":{"line":23,"column":1,"offset":491},"end":{"line":23,"column":10,"offset":500}},"content":["Purpose"]},{"type":"para","id":"KorS9pAWrDansTje93Tlp","margin":"","location":{"start":{"line":24,"column":1,"offset":501},"end":{"line":24,"column":216,"offset":716}},"text":"text","content":["Lots of modules need configuration files. Many Raku modules use JSON, or YAML. But neither YAML nor JSON is not Raku, and a configuration file has to be brought in and assigned to a data structure, typically a HASH."]},{"type":"para","id":"3gr4l1Yl9DF-9tXKKLB8r","margin":"","location":{"start":{"line":26,"column":1,"offset":718},"end":{"line":26,"column":96,"offset":813}},"text":"text","content":["But writing JSON or YAML means memorising the syntax of that language, then mapping it to Raku."]},{"type":"para","id":"BqZLKP4d5-xY7BnS48sCE","margin":"","location":{"start":{"line":28,"column":1,"offset":815},"end":{"line":28,"column":83,"offset":897}},"text":"text","content":["So, why not simply write the file in Raku and use EVALFILE to assign it to a Hash?"]},{"type":"para","id":"ZYb-cufOklSw1hrtWXuoJ","margin":"","location":{"start":{"line":30,"column":1,"offset":899},"end":{"line":30,"column":84,"offset":982}},"text":"text","content":["This module uses that idea, but allows for the configuration module to be anywhere."]},{"type":"para","id":"f52ebXgqEHAwpVR3pKTdE","margin":"","location":{"start":{"line":32,"column":1,"offset":984},"end":{"line":32,"column":148,"offset":1131}},"text":"text","content":["When reading in a configuration file, any Raku code is possible, so configuration files can look at Environment variables, or slurp in local files."]},{"type":"para","id":"QOoCJ0tV1uy0ssGCQKnxX","margin":"","location":{"start":{"line":34,"column":1,"offset":1133},"end":{"line":34,"column":160,"offset":1292}},"text":"text","content":["When writing a configuration file, there are many caveats relating to what can be serialised, but for static data, not closures, writing a config file is easy."]},{"type":"block","id":"RmaAYNEVbgz_RdB3HVRb3","margin":"","level":1,"name":"head","location":{"start":{"line":36,"column":1,"offset":1294},"end":{"line":36,"column":23,"offset":1316}},"content":["Installation and use"]},{"type":"para","id":"3y2GzSPe2r9wNNGUeUQqd","margin":"","location":{"start":{"line":37,"column":1,"offset":1317},"end":{"line":37,"column":7,"offset":1323}},"text":"text","content":["Simply"]},{"type":"block","id":"iGPB__GjoSh2kVWwlOV3S","margin":"","name":"code","config":[],"location":{"start":{"line":39,"column":1,"offset":1325},"end":{"line":41,"column":4,"offset":1355}},"content":[{"type":"verbatim","value":"zef install RakuConfig"}]},{"type":"para","id":"svGFjYrinuy3NaY7Zne9n","margin":"","location":{"start":{"line":42,"column":1,"offset":1356},"end":{"line":42,"column":5,"offset":1360}},"text":"text","content":["then"]},{"type":"block","id":"6bJoLL3lxUPqbfVmLSWPH","margin":"","name":"code","config":[],"location":{"start":{"line":44,"column":1,"offset":1362},"end":{"line":53,"column":4,"offset":1732}},"content":[{"type":"verbatim","value":"use RakuConfig;\nmy %config = get-config;\n# assumes that 'config.raku' exists in the current directory.\nmy %big-config = get-config( 'config-files' );\n# assumes multiple files of the for config-files/*.raku\n# files are evaluated in lexical order\n# detects whether keys in one file overwrite a previously set key\n# throws an Exception if an overwrite is attempted."}]},{"type":"block","id":"I8HrLW_iu884Euh_3IyUv","margin":"","level":1,"name":"head","location":{"start":{"line":54,"column":1,"offset":1733},"end":{"line":54,"column":32,"offset":1764}},"content":["Subs Only one sub is exported"]},{"type":"block","id":"vt0Ly9YPN2TEyLxwMx-tT","margin":"","level":2,"name":"head","location":{"start":{"line":55,"column":1,"offset":1765},"end":{"line":55,"column":14,"offset":1778}},"content":["get-config"]},{"type":"block","id":"OHCtr0oczsJhgOA_suvM0","margin":"","name":"code","config":[],"location":{"start":{"line":56,"column":1,"offset":1779},"end":{"line":64,"column":4,"offset":2266}},"content":[{"type":"verbatim","value":"#| :path is an existing file, or a current directory,\n#| if a directory, it should contain .raku files\n#| :required are the keys needed in a config after all .raku files are evaluated\n#| If :required is not given, or empty, no keys will be tested for existence\n#| With no parameters, the file 'config.raku' in the current directory is assumed\n#| Previous value of config is not used when :no-cache(True)\nmulti sub get-config(:$path = 'config.raku', :@required, :no-cache = False)"}]},{"type":"block","id":"XWGTSUCHYGR0GoAKaqsZB","margin":"","level":1,"name":"head","location":{"start":{"line":65,"column":1,"offset":2267},"end":{"line":65,"column":10,"offset":2276}},"content":["Testing"]},{"type":"para","id":"YYPmGCJbhzpAS6BhaBmh7","margin":"","location":{"start":{"line":66,"column":1,"offset":2277},"end":{"line":66,"column":214,"offset":2490}},"text":"text","content":["To reduce testing and installation hassle, the following have been removed from Test-depends: 'Test::META', 'Test::Deeply::Relaxed', 'File::Directory::Tree'\". They will need to be installed to prove the xt/ tests."]},{"type":"para","id":"8tLZC-ONEg6Jod8Ob88-f","margin":"","location":{"start":{"line":75,"column":1,"offset":2503},"end":{"line":75,"column":45,"offset":2547}},"text":"text","content":["Rendered from README at 2022-07-08T22:50:54Z"]}]},"publishUrl":"/mods/zef/RakuConfig/dist/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:finanalyst","authors":["Richard Hainsworth"],"build-depends":[],"depends":[],"description":"Get config files that are Raku structures","dist":"RakuConfig:ver<0.3.1>:auth<zef:finanalyst>","license":"Artistic-2.0","name":"RakuConfig","path":"R/AK/RAKUCONFIG/25a774f206e62fa738bf17cbe57a938a255ec51c.tar.gz","perl":"6.d","provides":{"RakuConfig":"lib/RakuConfig.pm6"},"resources":[],"source-type":"git","source-url":"git://github.com/finanalyst/raku-config.git","support":{"bugtracker":"https://github.com/finanalyst/raku-config/issues","email":"richard@hainsworth.wales","source":"https://github.com/finanalyst/raku-config.git"},"test-depends":[],"version":"0.3.1"},"files":[{"file":"work_mods/zef/RakuConfig/dist/README.md","publishUrl":"/mods/zef/RakuConfig/dist/README.md"},{"file":"work_mods/zef/RakuConfig/dist/CHANGELOG.md","publishUrl":"/mods/zef/RakuConfig/dist/CHANGELOG.md"},{"file":"work_mods/zef/RakuConfig/dist/CHANGELOG.pod6","publishUrl":"/mods/zef/RakuConfig/dist/CHANGELOG.pod6"},{"file":"work_mods/zef/RakuConfig/dist/README.pod6","publishUrl":"/mods/zef/RakuConfig/dist/README.pod6"}],"src":"zef","url":"/mods/zef/RakuConfig"}}}
    =end data
    =end React


RakuConfig


The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Rakudo::CORE::META

NAME

SYNOPSIS

DESCRIPTION

AUTHOR

COPYRIGHT AND LICENSE

Rakudo::CORE::META v0.0.3

Authors

License

Dependencies

Test Dependencies

Provides

Documentation