maddimathon
title: ReadMe
Utility TypeScript @ 2.0.0-beta
TypeScript utilities (types, functions, classes) to use in various projects.
Probably not best to use in production/client-side without a bundler (and including only the required exports) to avoid bulk, inefficiency, and alpha/beta items.
The library aims to be pretty configurable, but it's definitely targeted towards my personal needs/preferences rather than (web) developers in general.
Changelog
Read it from the source or the docs site.
Install
npm i -D @maddimathon/utility-typescript@2.0.0-beta
npm i -D github:maddimathon/utility-typescript#2.0.0-betaUse
For an overview of all exported items, including types, see the docs website below.
Exports & Entry Points
There are four defined entry points, including the root, though it should be possible to target individual files (carefully and at your own risk, paths may change without being considered a breaking change). The root entry point exports the other entry points as modules.
import {
type Types,
classes,
functions,
} from '@maddimathon/utility-typescript';
import type { ... } from '@maddimathon/utility-typescript/types';
import { ... } from '@maddimathon/utility-typescript/classes';
import { ... } from '@maddimathon/utility-typescript/functions';Development & Coding Practices
This library is maintained by Maddi Mathon and is currently unlikely to accept other contributions.
Each file that defines items/exports should limit its exports to one item and its associated types, if applicable. Occasionally (and judiciously), it may make more sense to define a small number of closely-related items in the same file.
Directory Structure
All files required for development but ommitted from the published package
should be in src/.
Files compiled in order to be included in the published package should be
written to dist/.
Documentation should be a valid HTML static site (for use with GitHub Pages)
with a home page at docs/index.html.
Scripts used for development (building, publishing, testing, etc.) should be in
.scripts/. Subfolders for classes, functions, and variables separate
resources from scripts meant to be run via npm.
Naming Conventions
Long and clear is better than short and confusing.
Abstract classes should start with Abstract (e.g.,
AbstractConfigurableClass).
Classes made only to be children of other classes should be prefixed with their
parent class (e.g., ParentClass_Child).
Documentation
Documentation is good and helpful. The docs website for this package is mostly auto-generated from block comments and typing in the source. Keeping the readme and changelog up to date is also important.
TypeDoc
Documentation for the included JavaScript is generated from the TypeScript types and block comments in the source. Every new addition should be thoroughly documented from the start.
To include source code in documentation, add the @source block tag (uses
typedoc-plugin-inline-sources).
Unit Testing
Unit tests are written in the source but run after compile and minimize (via
Build or Test scripts). Tests should be written in a file with the same path
but with .test added before the extension — e.g., myFunction.ts is tested by
myFunction.test.ts.
TypeScript
Every subdirectory should have its own index.ts that re-exports the contents
of its files. Types should also be tested using the utility types in
{@link Types.Test}.
License
This library uses the MIT license. Please read and understand the license — I promise it’s short!