https://github.com/chrynan/project-template-runner

A utility to iterate through a project directory and replace file names and text values with their appropriate project counterparts using Mustache templating.

https://github.com/chrynan/project-template-runner

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

A utility to iterate through a project directory and replace file names and text values with their appropriate project counterparts using Mustache templating.

Basic Info
  • Host: GitHub
  • Owner: chRyNaN
  • License: apache-2.0
  • Language: Kotlin
  • Default Branch: main
  • Homepage:
  • Size: 69.3 KB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created over 5 years ago · Last pushed over 5 years ago
Metadata Files
Readme License

README.md

project-template-runner

A utility to iterate through a project directory and replace file names and text values with their appropriate project counterparts using Mustache templating.

This utility was created to work in companion with my Kotlin Multi-platform Library Template on Github.

Note that this utility isn't meant to be a robust and reusable tool.

Usage

Define a Project JSON or YAML file with the following format (refer to the Project.kt file for more information):

{ "projectBaseDirectoryPath": "src", "projectName": "sample", "projectDescription": "Sample of using this utility.", "targetJvm": true, "targetJs": false, "targetAndroid": false, "targetIos": false, "enableTemplateData": false }

Then run the command with the path to that project file:

[command] [projectPath]

Sample

Refer to the project-template-runner-sample folder for an example.

Status

This project is still in the early stages of development.

Getting the Utility

Currently, you would have to clone the repository and build to generate the utility.

./gradlew build ./gradlew installDist

If you perform the above commands, the utility should be generated in the project-template-runner-app/build/install/project-template-runner-app/bin directory.

LICENSE

``` Copyright 2021 chRyNaN

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ```

Owner

  • Name: Christopher
  • Login: chRyNaN
  • Kind: user
  • Location: Austin, TX
  • Company: Starry

GitHub Events

Total
Last Year

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 1
  • Total Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Chris c****n@s****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: about 1 year ago


Dependencies

.github/workflows/greetings.yml actions
  • actions/first-interaction v1 composite
project-template-runner-app/build.gradle maven
  • org.jetbrains.kotlin:kotlin-stdlib * implementation
project-template-runner-core/build.gradle maven
  • com.github.ajalt.clikt:clikt 3.1.0 api
  • org.slf4j:slf4j-log4j12 1.7.29 api
  • com.charleskorn.kaml:kaml 0.28.3 implementation
  • com.github.jknack:handlebars 4.2.0 implementation
  • org.jetbrains.kotlinx:kotlinx-coroutines-core 1.4.2 implementation
  • org.jetbrains.kotlinx:kotlinx-serialization-json 1.0.1 implementation