Skip to main content

dna_tssuite 1.0.0 copy "dna_tssuite: ^1.0.0" to clipboard
dna_tssuite: ^1.0.0 copied to clipboard

DNA of all tssuite repos: every topic layer in one dependency

dna_tssuite #

The DNA of every tssuite repo: one dependency that pulls in the whole set of topic layers.

Add this one layer and a repo gets the README structure, the guides, the translations, the index, the blog format, the install guides, the VS Code settings, the clean code and test conventions, and the gg workflow.

Layers #

Layer What it brings
dna_readme README structure and templates
dna_guides developer and AI guides
dna_translate multi-language docs, de and en in sync
dna_index index and navigation files
dna_blog blog format, templates, layout
dna_install install guides: editor, node, Azure, tooling
dna_vscode shared editor settings and extensions
dna_clean_code how code is written and tested, incl. the TypeScript specifics
dna_gg the gg workflow, and the scripts it calls

This layer carries no files of its own — it exists to compose the ones above. Everything a tssuite repo sees comes from them.

Variables #

  • dnaCopyrightHolder — the name in the license header of every file, set to tssuite here
  • dnaCompany, dnaGitOrg, dnaGitOrgUrl — the organization, set to tssuite and https://github.com/tssuite here
  • dnaJiraPrefix — the prefix of a ticket id, set to TSS here

The topic layers require these in the layer listing them. This layer sets them, so repos listing it need not.

Usage #

Declare it as a dev-dependency and initialize once:

pnpm add -D @tssuite/dna-tssuite   # TypeScript projects
dart pub add dev:dna_tssuite       # Dart projects
gg dna init

The placed test instantiates and verifies the DNA on every test run.

Development #

The dna/ folder is hand-authored source and is never generated. The repo instantiates its own DNA — run dart test after changes; commit first, a file the DNA would overwrite must not carry uncommitted work.

0
likes
160
points
404
downloads

Documentation

API reference

Publisher

unverified uploader

Weekly Downloads

DNA of all tssuite repos: every topic layer in one dependency

Repository (GitHub)
View/report issues

License

MIT (license)

Dependencies

dna_blog, dna_clean_code, dna_gg, dna_guides, dna_index, dna_install, dna_readme, dna_scripts, dna_translate, dna_vscode

More

Packages that depend on dna_tssuite