├── .github
    ├── ISSUE_TEMPLATE
    │   ├── feature_request.md
    │   └── bug_report.md
    ├── workflows
    │   └── run-script.yaml
    └── PULL_REQUEST_TEMPLATE
├── LICENSE
├── scaffolded-script.kts
└── README.md


/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | ---
 5 | 
 6 | ## ⚠️ Is your feature request related to a problem? Please describe
 7 | <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 8 | 
 9 | ## 💡 Describe the solution you'd like
10 | <!-- A clear and concise description of what you want to happen. -->
11 | 
12 | ## 🤚 Do you want to develop this feature yourself?
13 | <!-- Put an `x` symbol into braces of desired choice. -->
14 | - [ ] Yes
15 | - [ ] No
16 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | ---
 5 | 
 6 | ## 🐛 Describe the bug
 7 | <!-- A clear and concise description of what the bug is. -->
 8 | 
 9 | ## ⚠️ Current behavior
10 | <!-- A clear and concise description of what you expected to happen. -->
11 | 
12 | ## ✅ Expected behavior
13 | <!-- A clear and concise description of what you expected to happen. -->
14 | 
15 | ## 💣 Steps to reproduce
16 | <!-- How we can reproduce the behavior: -->
17 | 
18 | ## 📷 Screenshots
19 | <!-- If applicable, add screenshots to help explain your problem. -->
20 | 
21 | ## 📱 Tech info
22 |  - Alfred Version: <!-- e.g. 4.0.9 -->
23 |  - OS: <!-- e.g. Mac OS 10.15.x -->
24 |  - Script version: <!-- e.g. 1.0 -->
25 | 


--------------------------------------------------------------------------------
/.github/workflows/run-script.yaml:
--------------------------------------------------------------------------------
 1 | name: Run Script
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - 'master'
 7 |   pull_request:
 8 |     branches:
 9 |       - '*'
10 | 
11 | jobs:
12 |   gradle:
13 |     defaults:
14 |       run:
15 |         shell: bash -i {0}
16 |     runs-on: ubuntu-latest
17 |     if: ${{ !contains(github.event.head_commit.message, 'ci skip') }}
18 |     steps:
19 |       - name: Checkout Repo
20 |         uses: actions/checkout@v2
21 |         with:
22 |           submodules: true
23 | 
24 |       - name: Install sdkman
25 |         run: curl -s "https://get.sdkman.io" | bash
26 |       - name: Install kotlin
27 |         run: sdk install kotlin
28 |       - name: Install kscript
29 |         run: sdk install kscript
30 |       - name: Run script
31 |         run: kscript scaffolded-script.kts
32 |       - name: Bundle script
33 |         run: kscript --package scaffolded-script.kts
34 | 
35 |       - uses: actions/upload-artifact@v1
36 |         with:
37 |           name: scaffolded-script
38 |           path: ./scaffolded-script
39 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2020 <Script Author>
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | of this software and associated documentation files (the "Software"), to deal
 5 | in the Software without restriction, including without limitation the rights
 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | copies of the Software, and to permit persons to whom the Software is
 8 | furnished to do so, subject to the following conditions:
 9 | 
10 | The above copyright notice and this permission notice shall be included in all
11 | copies or substantial portions of the Software.
12 | 
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 | SOFTWARE.


--------------------------------------------------------------------------------
/.github/PULL_REQUEST_TEMPLATE:
--------------------------------------------------------------------------------
 1 | <!-- Thanks for taking the time to write this Pull Request ❤️ -->
 2 | 
 3 | ## 🚀 Description
 4 | <!-- Describe your changes in detail -->
 5 | 
 6 | ## 📄 Motivation and Context
 7 | <!-- Why is this change required? What problem does it solve? -->
 8 | <!-- If it fixes an open issue, please link to the issue here. -->
 9 | 
10 | ## 🧪 How Has This Been Tested?
11 | <!-- Please describe in detail how you tested your changes. -->
12 | <!-- Include details of your testing environment, tests ran to see how -->
13 | <!-- your change affects other areas of the code, etc. -->
14 | 
15 | ## 📦 Types of changes
16 | <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
17 | - [ ] Bug fix (non-breaking change which fixes an issue)
18 | - [ ] New feature (non-breaking change which adds functionality)
19 | - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
20 | 
21 | ## ✅ Checklist
22 | <!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
23 | <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
24 | - [ ] My code follows the code style of this project.
25 | - [ ] My change requires a change to the documentation.
26 | - [ ] I have updated the documentation accordingly.


--------------------------------------------------------------------------------
/scaffolded-script.kts:
--------------------------------------------------------------------------------
 1 | #!/usr/bin/env kscript
 2 | @file:DependsOn("info.picocli:picocli:4.3.2")
 3 | 
 4 | import picocli.CommandLine
 5 | import picocli.CommandLine.Command
 6 | import picocli.CommandLine.Option
 7 | import picocli.CommandLine.Parameters
 8 | import java.io.File
 9 | import java.util.concurrent.Callable
10 | 
11 | 
12 | @Command(name = "scaffolded-script", mixinStandardHelpOptions = true, version = ["1.0"])
13 | class GenerateSnippets : Callable<Int> {
14 | 
15 |     private val DEFAULT_INPUT = "."
16 | 
17 |     @Option(names = ["-f", "--fail"], description = ["Ask the script to fail"])
18 |     private var SHOULD_FAIL: Boolean = false
19 | 
20 |     @Option(names = ["-i", "--input"], paramLabel = "FOLDER", description = ["The input .yml file to read from"])
21 |     private var INPUT: String = DEFAULT_INPUT
22 | 
23 |     override fun call(): Int {
24 |         info("📜📜📜 scaffolded-script 📜📜📜", "")
25 |         info("Welcome to scaffolded-script", "👋")
26 |         info("Should run a failure: $SHOULD_FAIL")
27 |         info("Input folder: $INPUT")
28 | 
29 |         if (SHOULD_FAIL) {
30 |             error("You asked me to fail...", Throwable("User requested failure"), 42)
31 |         }
32 |         if (INPUT == DEFAULT_INPUT) {
33 |             warn("Missing input folder, defaulting to [$DEFAULT_INPUT]")
34 |         }
35 |         info("Printing folder content...")
36 |         File(INPUT).walkTopDown().forEach {
37 |             info(it.path, "➡️")
38 |         }
39 |         succ("Script completed successfully!")
40 |         return 0
41 |     }
42 | 
43 | 
44 |     /*
45 |      * DEBUG Prints function
46 |      ******************************************************************/
47 | 
48 |     fun error(message: String, throwable: Throwable? = null, statusCode: Int = 1): Nothing {
49 |         System.err.println("❌\t${Colors.ANSI_RED}$message${Colors.ANSI_RESET}")
50 |         throwable?.let {
51 |             System.err.print(Colors.ANSI_RED)
52 |             it.printStackTrace()
53 |             System.err.print(Colors.ANSI_RESET)
54 | 
55 |         }
56 |         System.exit(statusCode)
57 |         throw Error()
58 |     }
59 | 
60 |     fun warn(message: String) {
61 |         System.out.println("⚠️\t${Colors.ANSI_YELLOW}$message${Colors.ANSI_RESET}")
62 |     }
63 | 
64 |     fun succ(message: String) {
65 |         System.out.println("✅\t${Colors.ANSI_GREEN}$message${Colors.ANSI_RESET}")
66 |     }
67 | 
68 |     fun info(message: String, emoji: String = "ℹ️") {
69 |         System.out.println("$emoji\t$message")
70 |     }
71 | }
72 | 
73 | CommandLine(GenerateSnippets()).execute(*args)
74 | 
75 | /*
76 |  * ASCII Color
77 |  ******************************************************************/
78 | 
79 | object Colors {
80 |     val ANSI_RESET = "\u001B[0m"
81 |     val ANSI_BLACK = "\u001B[30m"
82 |     val ANSI_RED = "\u001B[31m"
83 |     val ANSI_GREEN = "\u001B[32m"
84 |     val ANSI_YELLOW = "\u001B[33m"
85 |     val ANSI_BLUE = "\u001B[34m"
86 |     val ANSI_PURPLE = "\u001B[35m"
87 |     val ANSI_CYAN = "\u001B[36m"
88 |     val ANSI_WHITE = "\u001B[37m"
89 | }
90 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # kscript-template 📜
 2 | 
 3 | [![Use this template](https://img.shields.io/badge/from-kscript--template-brightgreen?logo=dropbox)](https://github.com/cortinico/kscript-template/generate) ![Run Script](https://github.com/cortinico/kscript-template/workflows/Run%20Script/badge.svg) ![License](https://img.shields.io/github/license/cortinico/kscript-template.svg) ![Language](https://img.shields.io/github/languages/top/cortinico/kotlin-android-template?color=blue&logo=kotlin)
 4 | 
 5 | A simple Github template that lets you create a [**kscript**](https://github.com/holgerbrandl/kscript) repository ready to run and share in a **few seconds**. 
 6 | 
 7 | ## How to use  👣
 8 | 
 9 | Just click on [![Use this template](https://img.shields.io/badge/-Use%20this%20template-brightgreen)](https://github.com/cortinico/kscript-template/generate) button to create a new repo starting from this template.
10 | 
11 | Once created don't forget to update the:
12 | - [Script name](scaffolded-script.kts) both the filename and the occurrencies inside the script.
13 | - The script name inside the Github Actions [workflow file](.github/workflows/run-script.yaml).
14 | 
15 | The templated script is just printing the list of files from a input directory. You can use this as a starting point to create your script around it:
16 | 
17 | <p align="center">
18 |     <img src="https://imgur.com/zi5CjIs.png" width="80%">
19 | </p>
20 | 
21 | ## Features 🎨
22 | 
23 | - Cli Args parsing with [picocli](https://github.com/remkop/picocli/).
24 | - Logging functions `info`, `warn`, `error`, `success` with emoji support ✅⚠️❌.
25 | - Support for ASCII colored output 🎨.
26 | - CI Setup with GitHub Actions.
27 | - Publishing of bundled artifact out of the box.
28 | - Issues Template (bug report + feature request).
29 | - Pull Request Template.
30 | 
31 | ## CLI Args ⌨️
32 | 
33 | This project is using [picocli](https://github.com/remkop/picocli/) to easily parse the CLI Options and Parameters. You can find more example on how to set up the flags on the [official documentation page](https://picocli.info/#_introduction).
34 | 
35 | You can use the `--help` flag to get a nice report for the available flags:
36 | 
37 | <p align="center">
38 |     <img src="https://imgur.com/KS6KtoV.png" width="80%">
39 | </p>
40 | 
41 | If you want to see how a failure looks like, invoke with `--fail` or `-f`:
42 | 
43 | <p align="center">
44 |     <img src="https://imgur.com/BYn1OxI.png" width="80%">
45 | </p>
46 | 
47 | ## Logging 📣
48 | 
49 | A couple of util functions are available for logging:
50 | * ℹ️ `info` to report a info message. You can optionally provide an emoji to enrich the log.
51 | * ✅ `succ` to report a green success message.
52 | * ⚠️ `warn` to report a yellow warning message.
53 | * ❌ `error` to report an error. Optionally you can provide also:
54 |     - A `Throwable` that will be logged on the screen
55 |     - An exit code `Int`. If not provided the default is `1`
56 | 
57 | Calling `error` will also stop the script.
58 | 
59 | ## CI ⚙️
60 | 
61 | This template is using [**GitHub Actions**](https://github.com/cortinico/kscript-template/actions) as CI. You don't need to setup any external service and you should have a running CI once you start using this template.
62 | 
63 | The workflow [Run Script](https://github.com/cortinico/kscript-template/actions?query=workflow%3A%22Run+Script%22) will take care of running the script and publishing the bundled version of it as an artifact (users can easily download it).
64 | 
65 | ## Contributing 🤝
66 | 
67 | Feel free to open a issue or submit a pull request for any bugs/improvements.


--------------------------------------------------------------------------------