Skip to content

Commit cc6b4bf

Browse files
committed
chore(release): 0.0.1
1 parent 092e7d8 commit cc6b4bf

File tree

13 files changed

+112
-153
lines changed

13 files changed

+112
-153
lines changed

.github/workflows/publish_package.yml

Lines changed: 0 additions & 56 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,4 @@
22

33
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
44

5-
### 1.0.1 (2021-08-09)
6-
7-
8-
### Bug Fixes
9-
10-
* replaced prepublish script with prepack ([#5](https://github.com/MapColonies/ts-npm-package-boilerplate/issues/5)) ([196259f](https://github.com/MapColonies/ts-npm-package-boilerplate/commit/196259f77cca41c45a9723c04da0d83b7555145b))
5+
### 0.0.1 (2021-09-14)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# ts-npm-package-boilerplate
1+
# read-pkg
22

33
After cloning this template, please do the following:
44
1. insert secrets to repo secrets for the github actions.
5-
2. replace every string "ts-npm-package-boilerplate" with your package name.
5+
2. replace every string "read-pkg" with your package name.

docs/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>@map-colonies/ts-npm-package-boilerplate</title>
7-
<meta name="description" content="Documentation for @map-colonies/ts-npm-package-boilerplate">
6+
<title>@map-colonies/read-pkg</title>
7+
<meta name="description" content="Documentation for @map-colonies/read-pkg">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="assets/css/main.css">
1010
<script async src="assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="index.html" class="title">@map-colonies/ts-npm-package-boilerplate</a>
26+
<a href="index.html" class="title">@map-colonies/read-pkg</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -50,21 +50,21 @@
5050
</div>
5151
<div class="tsd-page-title">
5252
<div class="container">
53-
<h1>@map-colonies/ts-npm-package-boilerplate</h1>
53+
<h1>@map-colonies/read-pkg</h1>
5454
</div>
5555
</div>
5656
</header>
5757
<div class="container container-main">
5858
<div class="row">
5959
<div class="col-8 col-content">
6060
<div class="tsd-panel tsd-typography">
61-
<a href="#ts-npm-package-boilerplate" id="ts-npm-package-boilerplate" style="color: inherit; text-decoration: none;">
62-
<h1>ts-npm-package-boilerplate</h1>
61+
<a href="#read-pkg" id="read-pkg" style="color: inherit; text-decoration: none;">
62+
<h1>read-pkg</h1>
6363
</a>
6464
<p>After cloning this template, please do the following:</p>
6565
<ol>
6666
<li>insert secrets to repo secrets for the github actions.</li>
67-
<li>replace every string &quot;ts-npm-package-boilerplate&quot; with your package name.</li>
67+
<li>replace every string &quot;read-pkg&quot; with your package name.</li>
6868
</ol>
6969
</div>
7070
</div>
@@ -78,8 +78,8 @@ <h1>ts-npm-package-boilerplate</h1>
7878
</nav>
7979
<nav class="tsd-navigation secondary menu-sticky">
8080
<ul class="before-current">
81-
<li class=" tsd-kind-variable">
82-
<a href="modules.html#cat" class="tsd-kind-icon">cat</a>
81+
<li class=" tsd-kind-function">
82+
<a href="modules.html#readpackagejsonsync" class="tsd-kind-icon">read<wbr>Package<wbr>Json<wbr>Sync</a>
8383
</li>
8484
</ul>
8585
</nav>

docs/modules.html

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<head>
44
<meta charset="utf-8">
55
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6-
<title>@map-colonies/ts-npm-package-boilerplate</title>
7-
<meta name="description" content="Documentation for @map-colonies/ts-npm-package-boilerplate">
6+
<title>@map-colonies/read-pkg</title>
7+
<meta name="description" content="Documentation for @map-colonies/read-pkg">
88
<meta name="viewport" content="width=device-width, initial-scale=1">
99
<link rel="stylesheet" href="assets/css/main.css">
1010
<script async src="assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
2323
<li class="state loading">Preparing search index...</li>
2424
<li class="state failure">The search index is not available</li>
2525
</ul>
26-
<a href="index.html" class="title">@map-colonies/ts-npm-package-boilerplate</a>
26+
<a href="index.html" class="title">@map-colonies/read-pkg</a>
2727
</div>
2828
<div class="table-cell" id="tsd-widgets">
2929
<div id="tsd-filter">
@@ -50,7 +50,7 @@
5050
</div>
5151
<div class="tsd-page-title">
5252
<div class="container">
53-
<h1>@map-colonies/ts-npm-package-boilerplate</h1>
53+
<h1>@map-colonies/read-pkg</h1>
5454
</div>
5555
</div>
5656
</header>
@@ -62,33 +62,41 @@ <h2>Index</h2>
6262
<section class="tsd-panel tsd-index-panel">
6363
<div class="tsd-index-content">
6464
<section class="tsd-index-section ">
65-
<h3>Variables</h3>
65+
<h3>Functions</h3>
6666
<ul class="tsd-index-list">
67-
<li class="tsd-kind-variable"><a href="modules.html#cat" class="tsd-kind-icon">cat</a></li>
67+
<li class="tsd-kind-function"><a href="modules.html#readpackagejsonsync" class="tsd-kind-icon">read<wbr>Package<wbr>Json<wbr>Sync</a></li>
6868
</ul>
6969
</section>
7070
</div>
7171
</section>
7272
</section>
7373
<section class="tsd-panel-group tsd-member-group ">
74-
<h2>Variables</h2>
75-
<section class="tsd-panel tsd-member tsd-kind-variable">
76-
<a name="cat" class="tsd-anchor"></a>
77-
<h3><span class="tsd-flag ts-flagConst">Const</span> cat</h3>
78-
<div class="tsd-signature tsd-kind-icon">cat<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>say<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
79-
<aside class="tsd-sources">
80-
<ul>
81-
<li>Defined in <a href="https://github.com/MapColonies/ts-npm-package-boilerplate/blob/94a0247/src/index.ts#L1">index.ts:1</a></li>
82-
</ul>
83-
</aside>
84-
<div class="tsd-type-declaration">
85-
<h4>Type declaration</h4>
86-
<ul class="tsd-parameters">
87-
<li class="tsd-parameter">
88-
<h5>say<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
89-
</li>
90-
</ul>
91-
</div>
74+
<h2>Functions</h2>
75+
<section class="tsd-panel tsd-member tsd-kind-function">
76+
<a name="readpackagejsonsync" class="tsd-anchor"></a>
77+
<h3>read<wbr>Package<wbr>Json<wbr>Sync</h3>
78+
<ul class="tsd-signatures tsd-kind-function">
79+
<li class="tsd-signature tsd-kind-icon">read<wbr>Package<wbr>Json<wbr>Sync<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, encoding<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">BufferEncoding</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PackageJson</span></li>
80+
</ul>
81+
<ul class="tsd-descriptions">
82+
<li class="tsd-description">
83+
<aside class="tsd-sources">
84+
<ul>
85+
<li>Defined in <a href="https://github.com/MapColonies/read-pkg/blob/cca742f/src/index.ts#L5">index.ts:5</a></li>
86+
</ul>
87+
</aside>
88+
<h4 class="tsd-parameters-title">Parameters</h4>
89+
<ul class="tsd-parameters">
90+
<li>
91+
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;./package.json&#x27;</span></h5>
92+
</li>
93+
<li>
94+
<h5>encoding: <span class="tsd-signature-type">BufferEncoding</span><span class="tsd-signature-symbol"> = &#x27;utf-8&#x27;</span></h5>
95+
</li>
96+
</ul>
97+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">PackageJson</span></h4>
98+
</li>
99+
</ul>
92100
</section>
93101
</section>
94102
</div>
@@ -102,8 +110,8 @@ <h5>say<span class="tsd-signature-symbol">: </span><span class="tsd-signature-ty
102110
</nav>
103111
<nav class="tsd-navigation secondary menu-sticky">
104112
<ul class="before-current">
105-
<li class=" tsd-kind-variable">
106-
<a href="modules.html#cat" class="tsd-kind-icon">cat</a>
113+
<li class=" tsd-kind-function">
114+
<a href="modules.html#readpackagejsonsync" class="tsd-kind-icon">read<wbr>Package<wbr>Json<wbr>Sync</a>
107115
</li>
108116
</ul>
109117
</nav>

package-lock.json

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

package.json

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,18 @@
11
{
2-
"name": "@map-colonies/ts-npm-package-boilerplate",
3-
"version": "1.0.1",
2+
"name": "@map-colonies/read-pkg",
3+
"version": "0.0.1",
44
"description": "This is template for map colonies typescript packages",
55
"main": "./dist/index.js",
66
"scripts": {
77
"test:unit": "jest --config=./tests/configurations/unit/jest.config.js",
8-
"test:integration": "jest --config=./tests/configurations/integration/jest.config.js",
98
"format": "prettier --check .",
109
"format:fix": "prettier --write .",
1110
"prelint:fix": "npm run format:fix",
1211
"prelint": "npm run format",
1312
"lint": "eslint .",
1413
"lint:fix": "eslint --fix .",
1514
"release": "standard-version",
16-
"test": "npm run test:unit && npm run test:integration",
15+
"test": "npm run test:unit",
1716
"prebuild": "npm run clean",
1817
"build": "tsc --project tsconfig.build.json",
1918
"start": "npm run build && cd dist && node ./index.js",
@@ -22,12 +21,12 @@
2221
},
2322
"repository": {
2423
"type": "git",
25-
"url": "git+https://github.com/MapColonies/ts-npm-package-boilerplate.git"
24+
"url": "git+https://github.com/MapColonies/read-pkg.git"
2625
},
2726
"author": "MapColonies",
2827
"license": "ISC",
2928
"bugs": {
30-
"url": "https://github.com/MapColonies/ts-npm-package-boilerplate/issues"
29+
"url": "https://github.com/MapColonies/read-pkg/issues"
3130
},
3231
"husky": {
3332
"hooks": {
@@ -38,7 +37,7 @@
3837
"files": [
3938
"dist/**/*"
4039
],
41-
"homepage": "https://github.com/MapColonies/ts-npm-package-boilerplate#readme",
40+
"homepage": "https://github.com/MapColonies/read-pkg#readme",
4241
"devDependencies": {
4342
"@commitlint/cli": "^11.0.0",
4443
"@commitlint/config-conventional": "^11.0.0",
@@ -60,5 +59,8 @@
6059
"ts-node": "^9.1.1",
6160
"typedoc": "^0.20.36",
6261
"typescript": "^4.2.4"
62+
},
63+
"dependencies": {
64+
"type-fest": "^2.3.2"
6365
}
6466
}

src/index.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1-
export const cat = {
2-
say: 'meow',
3-
};
1+
import { readFileSync } from 'fs';
2+
import { PackageJson } from 'type-fest';
3+
4+
export function readPackageJsonSync(path = './package.json', encoding: BufferEncoding = 'utf-8'): PackageJson {
5+
return JSON.parse(readFileSync(path, encoding)) as PackageJson;
6+
}

tests/configurations/integration/jest.config.js

Lines changed: 0 additions & 21 deletions
This file was deleted.

0 commit comments

Comments
 (0)