https://github.com/tscpp/knuckles

Modern development toolkit for Knockout 👊
https://github.com/tscpp/knuckles

eslint knockout knockout-lint knockout-ssr knockoutjs toolchain toolkit typescript vscode-knockout-binding-support

Last synced: 4 months ago
JSON representation

Modern development toolkit for Knockout 👊

• Host: GitHub
• URL: https://github.com/tscpp/knuckles
• Owner: tscpp
• License: mit
• Created: 2024-05-06T17:12:42.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-07-05T18:03:21.000Z (8 months ago)
• Last Synced: 2024-10-11T22:31:33.584Z (4 months ago)
• Topics: eslint, knockout, knockout-lint, knockout-ssr, knockoutjs, toolchain, toolkit, typescript, vscode-knockout-binding-support
• Language: TypeScript
• Homepage: https://knuckles.elsk.dev
• Size: 1.69 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Knuckles: Development Toolkit for Knockout.js](./assets/knuckles-banner.svg)](https://knuckles.elsk.dev)

[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/tscpp/knuckles/checks.yml?style=for-the-badge&logo=github&label=checks)](https://github.com/tscpp/knuckles/actions/workflows/checks.yml)

[![Coveralls](https://img.shields.io/coverallsCoverage/github/tscpp/knuckles?style=for-the-badge)](https://coveralls.io/github/tscpp/knuckles)

[![GitHub License](https://img.shields.io/github/license/tscpp/knuckles?style=for-the-badge)](https://github.com/tscpp/knuckles?tab=MIT-1-ov-file#readme)

[![NPM Downloads](https://img.shields.io/npm/dm/%40knuckles%2Fcli?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@knuckles/cli)



## What is Knuckles?

Knuckles is a development toolkit designed to enhance the developer experience (DX) using Knockout.js. It offers a range of useful tools for analyzing and optimizing Knockout.js applications. Each tool is entirely standalone and can be used independently. [See website ›](https://knuckles.elsk.dev/)

> No knockout without knuckles! 👊

## Features

### Analyzer

The analyzer allows you to check for issues in Knockout views before production. It allows you to utilize external tools, such as [TypeScript](#typescript) and [ESLint](#eslint), to check the bindings, while also providing a set of useful rules to catch common misstakes. [Read more ›](https://knuckles.elsk.dev/docs/analyzer/overview)

### TypeScript

As a plugin to the [analyzer](#analyzer), it can type-check the bindings in your Knockout views and provides a generated snapshot which other tools can use to provide type-aware analysis. [Read more ›](https://knuckles.elsk.dev/docs/analyzer/typescript)

### ESLint

As a plugin to the [analyzer](#analyzer), it can lint bindings using existing rules for JavaScript and [TypeScript](#typescript) (with type-aware rules). [Read more ›](https://knuckles.elsk.dev/docs/analyzer/eslint)

### SSR

Server-side rendering (SSR) allows you to render data into the view before handing it to the client to render. This can be used to greatly optimize runtime performance and SEO. [Read more ›](https://knuckles.elsk.dev/docs/ssr/overview)

### Editor Support

Implementaion currently only exists for [VSCode](/packages/readme/vscode).

The [language server](/packages/readme/language-server) provides language features to Knockout views, such as "go to definition", highlighting, diagnostics (from [analyzer](#analyzer)).

## License

All source code is licensed under the [MIT](https://choosealicense.com/licenses/mit/) license.

## Versioning

Verions adhear to [Semantic Versioning](https://semver.org/) (SemVer) v2.0.0.