Packages

Useful and simple to use packages based on the angular.io.

Package	Description	Status
callback	Manages the callback function.
change-detection	Improves application performance.
component-loader	Handles dynamic loading components.
core	Core features.
error	Manages an Error.
name	The name with prefix and suffix.
prism	Prism highlighter module.
property	Handles object properties.
range	The range between a minimum and maximum.
reactive	Automatize the process of creating some rxjs features.
storage	The storage of data under allowed names.
testing	Support for testing other packages.
type	Common types, type guards, and type checkers.
ui	User interface.	In Progress

Click on the package name to visit its GitHub page.

angular-package/name

The name with prefix and suffix.

---

Table of contents

• Basic concepts
• Skeleton
• Installation
• Api
• Object
  • Name
  • Prefix
  • Suffix
• Changelog
• Git
  • Commit
  • Versioning
• License

---

Basic concepts

Checks

It's to check the provided value to be the same as expected.

Type guard (constrain)

Constrains the parameter type to not let input unexpected value in the code editor.

Guards

It's a combination of both above, constrains the type of the parameter in the code editor, and checks its provided argument.

Defines

Returns defined value from a method of an object.
Defines new value in an object and returns a defined value.

Gets

Returns a value from an object.

Sets

Adds or updates an element with a specified key and a value to an object and returns an object.

Skeleton

This package was built by the library skeleton which was generated with Angular CLI version 12.2.5.

Copy this package to the packages/name folder of the library skeleton then run the commands below.

Code scaffolding

Run ng generate component component-name --project name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module --project name.

Note: Don't forget to add --project name or else it will be added to the default project in your angular.json file.

Build

Run ng build name to build the package. The build artifacts will be stored in the dist/ directory.

Publishing

After building your library with ng build name, go to the dist folder cd dist/name and run npm publish.

Running unit tests

Install @angular-package/testing with command:

npm i @angular-package/testing --no-save

Run ng test name to execute the unit tests via Karma.

Installation

Install @angular-package/name package with command:

npm i @angular-package/name --save

Api

import {
  // Class.
  Name,
  Prefix,
  Suffix,
} from '@angular-package/name';

Changelog

The changelog of this package is based on keep a changelog. To read it, click on the CHANGELOG.md link.

A changelog is a file which contains a curated, chronologically ordered list of notable changes for each version of a project. - keep a changelog

GIT

Commit

• AngularJS Git Commit Message Conventions
• Karma Git Commit Msg
• Conventional Commits

Versioning

Semantic Versioning 2.0.0

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API changes,
• MINOR version when you add functionality in a backwards-compatible manner, and
• PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

FAQ How should I deal with revisions in the 0.y.z initial development phase?

The simplest thing to do is start your initial development release at 0.1.0 and then increment the minor version for each subsequent release.

How do I know when to release 1.0.0?

If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backwards compatibility, you should probably already be 1.0.0.

License

MIT © angular-package (license)