kist

Package Pipeline Processor

https://github.com/getkist/kist

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 (8.2%) to scientific vocabulary

Keywords

build builder compiler css javascript js npm package package-json packager packages packaging pipeline scss ts typescript

Keywords from Contributors

earthobservation interactive favicon sitemap network-simulation hacking embedded optim standardization projection
Last synced: 6 months ago · JSON representation

Repository

Package Pipeline Processor

Basic Info
  • Host: GitHub
  • Owner: getkist
  • License: mit
  • Language: TypeScript
  • Default Branch: dev
  • Homepage: https://getkist.com
  • Size: 7.41 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 3
  • Releases: 81
Topics
build builder compiler css javascript js npm package package-json packager packages packaging pipeline scss ts typescript
Created about 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security Authors

README.md

kist logo

kist

Package Pipeline Processor


[![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.kist&up_message=Up&up_color=5e4d34&down_message=Down&down_color=5e4d34&style=flat-square&logo=Firefox&logoColor=FFFFFF&label=Website&labelColor=5e4d34&color=5e4d34) ](https://www.kist) [![NPM Version](https://img.shields.io/npm/v/kist?style=flat-square&logo=npm&logoColor=FFFFFF&label=NPM&labelColor=5e4d34&color=5e4d34&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fkist)](https://www.npmjs.com/package/kist) [![devContainer](https://img.shields.io/badge/devContainer-235e4d34?style=flat-square&logo=Docker&logoColor=%23FFFFFF&labelColor=%235e4d34&color=%235e4d34)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/getkist/kist) [![StackBlitz](https://img.shields.io/badge/StackBlitz-235e4d34?style=flat-square&logo=StackBlitz&logoColor=%23FFFFFF&labelColor=%235e4d34&color=%235e4d34)](https://stackblitz.com/github/getkist/kist/tree/main?file=src%2Findex.html) [![GitHub License](https://img.shields.io/github/license/getkist/kist?style=flat-square&logo=readthedocs&logoColor=FFFFFF&label=&labelColor=%235e4d34&color=%235e4d34&link=LICENSE)](https://github.com/getkist/kist/blob/main/LICENSE)
[![Report a Bug](https://img.shields.io/badge/Report%20a%20Bug-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23D2D9DF)](https://github.com/getkist/kist/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=bug_report.yml) [![Request a Feature](https://img.shields.io/badge/Request%20a%20Feature-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23D2D9DF)](https://github.com/getkist/kist/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=feature_request.yml) [![Ask a Question](https://img.shields.io/badge/Ask%20a%20Question-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23D2D9DF)](https://github.com/getkist/kist/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=question.yml) [![Make a Suggestion](https://img.shields.io/badge/Make%20a%20Suggestion-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23D2D9DF)](https://github.com/getkist/kist/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=suggestion.yml) [![Start a Discussion](https://img.shields.io/badge/Start%20a%20Discussion-GitHub?style=flat-square&&logoColor=%23FFFFFF&color=%23D2D9DF)](https://github.com/getkist/kist/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&projects=&template=discussion.yml)
---
kist is a highly customizable and efficient package builder designed to streamline software development workflows. It provides a modular framework for managing build pipelines with support for live reload functionality. `kist` is a package builder designed to enhance the efficiency and organization of software development projects. Key to its design philosophy is the adaptability to various development workflows, making it an ideal companion for a range of projects from small-scale personal endeavors to large, complex enterprise applications. `kist` stands not just as a tool but as a partner in the software development journey, enhancing productivity, reducing overhead, and bringing clarity and ease to the package management process. --- ## Features - Modular pipeline system with stages and steps. - Live reload functionality for enhanced developer experience. - Plugin-based architecture to extend functionality. - TypeScript support for a modern development workflow. - Robust error handling and logging. --- ## Quickstart To install `kist`, use npm or yarn: ### NPM ```bash npm install kist --save-dev ``` ### Yarn ```bash yarn add kist --dev ``` --- ## Installation 1. Clone the Repository: ```sh git clone cd kist ``` 2. Install Dependencies: ```sh npm install ``` 3. Build the Project: ```sh npm run build ``` 4. Link the CLI Globally: ```sh npm link ``` --- ## Usage ### Run the Pipeline Run the pipeline defined in your pack.yaml file: ```sh pack ``` ### Enable Live Reload Run the pipeline with live reload enabled: ```sh pack --live ``` --- ## Configuration The pipeline configuration is defined in a pack.yaml file located in the root of your project. Heres an example: ```sh stages: - name: build steps: - name: compile action: build options: source: src/ output: dist/ - name: test dependsOn: [build] steps: - name: run-tests action: test ``` Stage and Step Structure - Stages: Define a group of steps to be executed. - Steps: Individual tasks within a stage (e.g., compiling, testing). - Dependencies: Stages can depend on other stages to enforce execution order. --- ## Development ### Build Compile the TypeScript files into JavaScript: ```sh npm run build-tsc ``` ### Lint Run ESLint to check for code issues: ```sh npm run lint ``` ### Run Tests Run all tests in the src/tests directory: ```sh npm run test ``` ### Live Reload To enable live reload during development, add the --live flag: ```sh pack --live ``` --- ## Folder Structure ```sh kist/ src/ core/ # Core pipeline logic live/ # Live reload server and related components actions/ # Built-in step actions (e.g., build, test) tests/ # Unit tests pack.ts # Entry point for the CLI dist/ # Compiled JavaScript output pack.yaml # Example configuration file package.json # Project metadata and dependencies tsconfig.json # TypeScript configuration README.md # Project documentation ``` --- ## Key Components ### Pipeline The Pipeline class manages the execution of stages and steps defined in the pack.yaml file. ### LiveReloadServer The LiveReloadServer provides live reload functionality by watching files for changes and notifying connected clients. ### ConfigLoader The ConfigLoader reads and validates the pipeline configuration from the pack.yaml file. ### Actions kist supports plugin-based actions. Default actions include: - build: Compiles source files. - test: Runs tests. - lint: Lints the codebase. Custom actions can be implemented and registered as plugins. ```mermaid graph TD subgraph Pipeline Stage1[Stage 1] Stage2[Stage 2] Stage3[Stage 3] end subgraph Stage1 Step1_1[Step 1.1] Step1_2[Step 1.2] end subgraph Stage2 Step2_1[Step 2.1] Step2_2[Step 2.2] end subgraph Stage3 Step3_1[Step 3.1] Step3_2[Step 3.2] end Step1_1 --> Action1_1[Action: DirectoryCleanAction] Step1_2 --> Action1_2[Action: DirectoryCopyAction] Step2_1 --> Action2_1[Action: FileCopyAction] Step2_2 --> Action2_2[Action: StyleProcessingAction] Step3_1 --> Action3_1[Action: PackageManagerAction] Step3_2 --> Action3_2[Action: VersionWriteAction] Stage1 --> Stage2 Stage2 --> Stage3 ``` --- ## Colophon ### Authors **kist** is an open-source project by **[Scape Agency](https://www.scape.agency "Scape Agency website")**. #### Scape Agency Scape Agency is a spatial innovation collective that dreams, discovers and designs the everyday of tomorrow. We blend design thinking with emerging technologies to create a brighter perspective for people and planet. Our products and services naturalise technology in liveable and sustainable scapes that spark the imagination and inspire future generations. - website: [scape.agency](https://www.scape.agency "Scape Agency website") - github: [github.com/getkist](https://github.com/getkist "Scape Agency GitHub") ### Development Resources #### Contributing We'd love for you to contribute and to make this project even better than it is today! Please refer to the [contribution guidelines](.github/CONTRIBUTING.md) for information. Contributions are welcome! Follow these steps to contribute: 1. Fork the repository. 2. Create a new feature branch. 3. Make your changes and write tests. 4. Submit a pull request. ### Legal Information #### Copyright Copyright © 2025 [Scape Agency BV](https://www.scape.agency/ "Scape Agency website"). All Rights Reserved. #### License Except as otherwise noted, the code in this repository is licensed under the MIT License. Also see [LICENSE](https://github.com/getkist/community/blob/master/src/LICENSE). The documentation is licensed under the [Creative Commons Attribution 4.0 International (CC BY 4.0) License](https://creativecommons.org/licenses/by/4.0/). #### Disclaimer **THIS SOFTWARE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.** ---

Made with by Scape Agency

Owner

  • Name: kist
  • Login: getkist
  • Kind: organization

GitHub Events

Total
  • Create event: 167
  • Release event: 12
  • Issues event: 1
  • Delete event: 149
  • Issue comment event: 162
  • Push event: 173
  • Pull request event: 299
Last Year
  • Create event: 167
  • Release event: 12
  • Issues event: 1
  • Delete event: 149
  • Issue comment event: 162
  • Push event: 173
  • Pull request event: 299

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 1,285
  • Total Committers: 2
  • Avg Commits per committer: 642.5
  • Development Distribution Score (DDS): 0.149
Past Year
  • Commits: 1,168
  • Committers: 2
  • Avg Commits per committer: 584.0
  • Development Distribution Score (DDS): 0.159
Top Committers
Name Email Commits
Lars van Vianen l****s@v****m 1,093
dependabot[bot] 4****] 192
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 319
  • Average time to close issues: less than a minute
  • Average time to close pull requests: 1 day
  • Total issue authors: 2
  • Total pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 1.07
  • Merged pull requests: 274
  • Bot issues: 1
  • Bot pull requests: 319
Past Year
  • Issues: 2
  • Pull requests: 319
  • Average time to close issues: less than a minute
  • Average time to close pull requests: 1 day
  • Issue authors: 2
  • Pull request authors: 1
  • Average comments per issue: 0.5
  • Average comments per pull request: 1.07
  • Merged pull requests: 274
  • Bot issues: 1
  • Bot pull requests: 319
Top Authors
Issue Authors
  • vanvianen (1)
Pull Request Authors
  • dependabot[bot] (319)
Top Labels
Issue Labels
Pull Request Labels
dependencies (319) javascript (1)

Packages

  • Total packages: 1
  • Total downloads:
    • npm 278 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 14
  • Total maintainers: 1
npmjs.org: kist

Package Pipeline Processor

  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 278 Last month
Rankings
Dependent repos count: 25.1%
Average: 30.7%
Dependent packages count: 36.3%
Maintainers (1)
Funding
  • type: github: url: https://github.com/sponsors/scape-foundation
Last synced: 6 months ago