1- # TypeScript Module Package Skeleton
1+ # NextLove CSharp SDK
22
3- [ ![ GitHub Actions] ( https://github.com/seamapi/makenew-tsmodule /actions/workflows/check.yml/badge.svg )] ( https://github.com/seamapi/makenew-tsmodule /actions/workflows/check.yml )
3+ [ ![ GitHub Actions] ( https://github.com/seamapi/nextlove-sdk-csharp /actions/workflows/check.yml/badge.svg )] ( https://github.com/seamapi/nextlove-sdk-csharp /actions/workflows/check.yml )
44
5- Package skeleton for a TypeScript module .
5+ CSharp SDK autogenerated from nextlove types .
66
77## Description
88
9- Bootstrap a new TypeScript module in five minutes or less.
10-
11- ### Features
12-
13- - Strongly typed JavaScript with [ TypeScript] .
14- - Native [ ECMAScript module] compatible with [ Node.js] .
15- - Package management with [ npm] .
16- - Use private packages from [ GitHub Packages] .
17- - Publish as a private package to [ GitHub Packages] .
18- - Examples with configurable options and arguments powered by [ yargs] with [ landlubber] .
19- - Linting with the [ JavaScript Standard Style] using [ ESLint] .
20- - [ Prettier] code.
21- - Futuristic debuggable unit testing with [ AVA] .
22- - Code coverage reporting with [ Istanbul] and [ c8] .
23- - Robust static dependency analysis with [ DPDM] .
24- - Fully automated version management and package publishing with [ semantic-release] .
25- - Continuous testing and package publishing with [ GitHub Actions] .
26- - Consistent coding with [ EditorConfig] .
27- - Start coding instantly with [ GitHub Codespaces] .
28- - Get PR reviews directly from [ code owners] .
29- - Automatically close [ stale] Issues and Pull Requests.
30-
31- [ AVA ] : https://github.com/avajs/ava
32- [ code owners ] : https://github.blog/2017-07-06-introducing-code-owners/
33- [ DPDM ] : https://github.com/acrazing/dpdm
34- [ ECMAScript module ] : https://nodejs.org/api/esm.html
35- [ ESLint ] : https://eslint.org/
36- [ EditorConfig ] : https://editorconfig.org/
37- [ GitHub Actions ] : https://github.com/features/actions
38- [ GitHub Codespaces ] : https://github.com/features/packages
39- [ GitHub Packages ] : https://github.com/features/packages
40- [ Istanbul ] : https://istanbul.js.org/
41- [ JavaScript Standard Style ] : https://standardjs.com/
42- [ Node.js ] : https://nodejs.org/
43- [ Prettier ] : https://prettier.io/
44- [ semantic-release ] : https://semantic-release.gitbook.io/
45- [ stale ] : https://github.com/marketplace/stale
46- [ TypeScript ] : https://www.typescriptlang.org/
47- [ c8 ] : https://github.com/bcoe/c8
48- [ landlubber ] : https://github.com/razor-x/landlubber
49- [ npm ] : https://www.npmjs.com/
50- [ yargs ] : https://yargs.js.org/
51-
52- ### Bootstrapping a new project
53-
54- 1 . [ Trigger a makenew workflow from this repository] [ makenew workflow ] . 🚀
55- - Provide a value for each required input.
56- - There are no defaults.
57- - Example values are shown in parentheses.
58- 2 . When the workflow completes, clone your new repo and start coding!
59-
60- [ makenew workflow ] : https://github.com/seamapi/makenew-tsmodule/actions/workflows/makenew.yml
61-
62- ### Updating from this skeleton
63-
64- If you want to pull in future updates from this skeleton,
65- you can fetch and merge in changes from this repository.
66-
67- Add this as a new remote with
68-
69- ```
70- $ git remote add makenew [email protected] :seamapi/makenew-tsmodule.git 71- ```
72-
73- You can then fetch and merge changes with
74-
75- ```
76- $ git fetch --no-tags makenew
77- $ git merge makenew/main
78- ```
9+ TODO
7910
8011## Installation
8112
@@ -89,7 +20,7 @@ by adding the line below to your project's `.npmrc`,
8920and installing the package with
9021
9122```
92- $ npm install @seamapi/makenew-tsmodule
23+ $ npm install @seamapi/nextlove-sdk-csharp
9324```
9425
9526[ npm ] : https://www.npmjs.com/
@@ -99,8 +30,8 @@ $ npm install @seamapi/makenew-tsmodule
9930### Quickstart
10031
10132```
102- $ git clone https://github.com/seamapi/makenew-tsmodule .git
103- $ cd makenew-tsmodule
33+ $ git clone https://github.com/seamapi/nextlove-sdk-csharp .git
34+ $ cd nextlove-sdk-csharp
10435$ nvm install
10536$ npm install
10637$ npm run test:watch
@@ -120,10 +51,10 @@ The [source code] is hosted on GitHub.
12051Clone the project with
12152
12253```
123- $ git clone [email protected] :seamapi/makenew-tsmodule .git 54+ $ git clone [email protected] :seamapi/nextlove-sdk-csharp .git 12455```
12556
126- [ source code ] : https://github.com/seamapi/makenew-tsmodule
57+ [ source code ] : https://github.com/seamapi/nextlove-sdk-csharp
12758
12859### Requirements
12960
@@ -178,7 +109,7 @@ $ gh workflow run version.yml --raw-field version=<version>
178109
179110[ GitHub CLI ] : https://cli.github.com/
180111[ npm-version ] : https://docs.npmjs.com/cli/version
181- [ version workflow_dispatch on GitHub Actions ] : https://github.com/seamapi/makenew-tsmodule /actions?query=workflow%3Aversion
112+ [ version workflow_dispatch on GitHub Actions ] : https://github.com/seamapi/nextlove-sdk-csharp /actions?query=workflow%3Aversion
182113
183114## GitHub Actions
184115
0 commit comments