diff --git a/.lune/build.luau b/.lune/build.luau index 2474aff..baa11a0 100644 --- a/.lune/build.luau +++ b/.lune/build.luau @@ -40,6 +40,19 @@ end ]], } +local README_TMPL = [[# `pesde/scripts_%s` +Common scripts intended for use with %s. + +## Included scripts +### roblox_sync_config_generator + +Generates a %s sync config for pesde Roblox packages. + +### sourcemap_generator + +Prints out a sourcemap for Wally dependencies for type extraction. +]] + local function logPrefix(type: "error" | "info") local statusColor: stdio.Color = if type == "error" then "red" @@ -116,19 +129,28 @@ for tool, generators in lib.generators do pathfs.writeDir(toolScriptsDir) end + local capitalisedToolChoice = string.gsub(toolChoice, "^%l", string.upper) + -- Define the manifest for the tool local toolManifest: manifest.PesdeManifest = { name = `pesde/scripts_{toolChoice}`, version = toolMeta.version, -- For the description, we capitalize the first letter of the tool name here -- since it is a proper noun - description = `Scripts for {string.gsub(toolChoice, "^%l", string.upper)}-based Roblox projects.`, + description = `Scripts for {capitalisedToolChoice}-based Roblox projects.`, authors = { "daimond113 (https://www.daimond113.com/)", "Erica Marigold ", }, repository = "https://github.com/pesde-pkg/scripts", license = "MIT", + includes = { + "roblox_sync_config_generator.luau", + "sourcemap_generator.luau", + "pesde.toml", + "README.md", + "LICENSE", + }, target = { environment = "lune", @@ -156,6 +178,11 @@ for tool, generators in lib.generators do pathfs.writeFile(toolScriptsDir:join("pesde.toml"), serde.encode("toml", toolManifest, true)) pathfs.writeFile(toolScriptsDir:join("roblox_sync_config_generator.luau"), syncConfigGeneratorScript) pathfs.writeFile(toolScriptsDir:join("sourcemap_generator.luau"), sourcemapGeneratorScript) + pathfs.writeFile( + toolScriptsDir:join("README.md"), + string.format(README_TMPL, toolChoice, capitalisedToolChoice, capitalisedToolChoice) + ) + pathfs.copy(pathfs.cwd:join("LICENSE"), toolScriptsDir:join("LICENSE"), true) stdio.write( `{INFO_PREFIX} Generated script project for tool {toolChoice} ({stdio.style("dim")}{string.format( diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f4d84c0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 pesde-pkg + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 7924a3f..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,7 +0,0 @@ -Copyright © 2024 pesde-pkg - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/pesde.toml b/pesde.toml index 9230cf6..fa6d169 100644 --- a/pesde.toml +++ b/pesde.toml @@ -13,7 +13,7 @@ includes = [ "!src/**/*.spec.luau", "pesde.toml", "README.md", - "LICENSE.md", + "LICENSE", ] workspace_members = [".", ".pesde/rojo"]