Skip to content

Commit c9c6085

Browse files
authored
Merge pull request #1 from typescript-package/develop
v1.0.0-beta
2 parents e18a9d1 + 5494712 commit c9c6085

22 files changed

+1190
-0
lines changed

.github/FUNDING.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: [angular-package] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: angularpackage # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.gitignore

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# See https://docs.github.com/get-started/getting-started-with-git/ignoring-files for more about ignoring files.
2+
3+
# Compiled output
4+
/dist
5+
/tmp
6+
/out-tsc
7+
/bazel-out
8+
9+
# Node
10+
/node_modules
11+
npm-debug.log
12+
yarn-error.log
13+
14+
# IDEs and editors
15+
.idea/
16+
.project
17+
.classpath
18+
.c9/
19+
*.launch
20+
.settings/
21+
*.sublime-workspace
22+
23+
# Visual Studio Code
24+
.vscode/*
25+
!.vscode/settings.json
26+
!.vscode/tasks.json
27+
!.vscode/launch.json
28+
!.vscode/extensions.json
29+
.history/*
30+
31+
# Miscellaneous
32+
/.angular/cache
33+
.sass-cache/
34+
/connect.lock
35+
/coverage
36+
/libpeerconnection.log
37+
testem.log
38+
/typings
39+
40+
# System files
41+
.DS_Store
42+
Thumbs.db
43+
44+
*.ignore*
45+
temp

README.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
2+
<a href="https://www.typescriptlang.org/">
3+
<img
4+
src="https://raw.githubusercontent.com/typescript-package/core/refs/heads/main/ts-package-barcode-logo-512.png"
5+
width="20%"
6+
title="@typescript-package/descriptor"
7+
/>
8+
</a>
9+
10+
## typescript-package/descriptor
11+
12+
<!-- npm badge -->
13+
[![npm version][typescript-package-npm-badge-svg]][typescript-package-npm-badge]
14+
[![GitHub issues][typescript-package-badge-issues]][typescript-package-issues]
15+
[![GitHub license][typescript-package-badge-license]][typescript-package-license]
16+
17+
**Version:** v1.0.0-beta
18+
19+
A **lightweight** TypeScript library for property descriptor.
20+
21+
## Table of contents
22+
23+
- [Installation](#installation)
24+
- [Api](#api)
25+
- `AccessorDescriptor`
26+
- `CommonDescriptor`
27+
- `DataDescriptor`
28+
- `Descriptor`
29+
- `Descriptors`
30+
- `PropertyDescriptorChain`
31+
- [Contributing](#contributing)
32+
- [Code of Conduct](code-of-conduct)
33+
- [Git](#git)
34+
- [Commit](#commit)
35+
- [Versioning](#versioning)
36+
- [License](#license)
37+
38+
## Installation
39+
40+
```bash
41+
npm install @typescript-package/descriptor --save-peer
42+
```
43+
44+
## Api
45+
46+
```typescript
47+
import {
48+
// Abstract.
49+
CommonDescriptor,
50+
// Class.
51+
AccessorDescriptor,
52+
DataDescriptor,
53+
Descriptor,
54+
Descriptors,
55+
PropertyDescriptorChain,
56+
} from '@typescript-package/descriptor';
57+
```
58+
59+
## Contributing
60+
61+
Your contributions are **valued**! If you'd like to contribute, please feel **free** to submit a pull request. Help is always appreciated.
62+
63+
## Code of Conduct
64+
65+
By participating in this project, you agree to follow **[Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)**.
66+
67+
## GIT
68+
69+
### Commit
70+
71+
Please follow the following commit message conventions:
72+
73+
- [AngularJS Git Commit Message Conventions][git-commit-angular]
74+
- [Karma Git Commit Msg][git-commit-karma]
75+
- [Conventional Commits][git-commit-conventional]
76+
77+
### Versioning
78+
79+
The package follows [Semantic Versioning 2.0.0][git-semver] for all releases. The versioning format is:
80+
81+
**Given a version number MAJOR.MINOR.PATCH, increment the:**
82+
83+
- MAJOR version when you make incompatible API changes,
84+
- MINOR version when you add functionality in a backwards-compatible manner, and
85+
- PATCH version when you make backwards-compatible bug fixes.
86+
87+
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
88+
89+
**FAQ**
90+
How should I deal with revisions in the 0.y.z initial development phase?
91+
92+
> 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.
93+
94+
How do I know when to release 1.0.0?
95+
96+
> 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.
97+
98+
## License
99+
100+
MIT © typescript-package ([license][typescript-package-license])
101+
102+
<!-- This package: typescript-package -->
103+
<!-- GitHub: badges -->
104+
[typescript-package-badge-issues]: https://img.shields.io/github/issues/typescript-package/descriptor
105+
[isscript-package-badge-forks]: https://img.shields.io/github/forks/typescript-package/descriptor
106+
[typescript-package-badge-stars]: https://img.shields.io/github/stars/typescript-package/descriptor
107+
[typescript-package-badge-license]: https://img.shields.io/github/license/typescript-package/descriptor
108+
<!-- GitHub: badges links -->
109+
[typescript-package-issues]: https://github.com/typescript-package/descriptor/issues
110+
[typescript-package-forks]: https://github.com/typescript-package/descriptor/network
111+
[typescript-package-license]: https://github.com/typescript-package/descriptor/blob/master/LICENSE
112+
[typescript-package-stars]: https://github.com/typescript-package/descriptor/stargazers
113+
<!-- This package -->
114+
115+
<!-- Package: typescript-package -->
116+
<!-- npm -->
117+
[typescript-package-npm-badge-svg]: https://badge.fury.io/js/@typescript-package%2Fdescriptor.svg
118+
[typescript-package-npm-badge]: https://badge.fury.io/js/@typescript-package%2Fdescriptor
119+
120+
<!-- GIT -->
121+
[git-semver]: http://semver.org/
122+
123+
<!-- GIT: commit -->
124+
[git-commit-angular]: https://gist.github.com/stephenparish/9941e89d80e2bc58a153
125+
[git-commit-karma]: http://karma-runner.github.io/0.10/dev/git-commit-msg.html
126+
[git-commit-conventional]: https://www.conventionalcommits.org/en/v1.0.0/

ng-package.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
3+
"dest": "../../dist/descriptor",
4+
"lib": {
5+
"entryFile": "src/public-api.ts"
6+
},
7+
"keepLifecycleScripts": true
8+
}

package-lock.json

Lines changed: 112 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"name": "@typescript-package/descriptor",
3+
"version": "1.0.0-beta",
4+
"author": "wwwdev.io <[email protected]>",
5+
"description": "A lightweight TypeScript library for property descriptor.",
6+
"license": "MIT",
7+
"publishConfig": {
8+
"access": "public",
9+
"registry": "https://registry.npmjs.org"
10+
},
11+
"peerDependencies": {
12+
"@typedly/callback": "^1.0.0-beta.4",
13+
"@typedly/descriptor": "^2.0.0"
14+
},
15+
"scripts": {
16+
"prepublishOnly": "npm run pkg && npm run clean",
17+
"pkg": "npm pkg delete module dependencies",
18+
"clean": "npm pkg delete scripts"
19+
},
20+
"repository": {
21+
"type": "git",
22+
"url": "git+https://github.com/typescript-package/descriptor.git"
23+
},
24+
"bugs": {
25+
"url": "https://github.com/typescript-package/descriptor/issues"
26+
},
27+
"keywords": [
28+
"@typescript-package",
29+
"@typescript-package/descriptor",
30+
"AccessorDescriptor",
31+
"CommonDescriptor",
32+
"DataDescriptor",
33+
"Descriptor",
34+
"Descriptors",
35+
"PropertyDescriptorChain"
36+
],
37+
"funding": [
38+
{
39+
"type": "stripe",
40+
"url": "https://donate.stripe.com/dR614hfDZcJE3wAcMM"
41+
},
42+
{
43+
"type": "revolut",
44+
"url": "https://checkout.revolut.com/pay/048b10a3-0e10-42c8-a917-e3e9cb4c8e29"
45+
}
46+
],
47+
"sideEffects": false
48+
}

0 commit comments

Comments
 (0)