Skip to content

Commit

Permalink
Merge pull request #10 from Microsoft/version-bump
Browse files Browse the repository at this point in the history
[nodejs] Dependency and version bump.
  • Loading branch information
Mmdixon authored Nov 6, 2018
2 parents 62fc593 + 0cdaa3c commit 13f18f1
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 46 deletions.
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ <h1 id="introduction">Introduction</h1>
</ul>
<p>(Run <code>node -p &quot;process.versions.modules&quot;</code> to see which Node-ABI in use.)</p>
<h1 id="getting-started">Getting Started</h1>
<p>This repository consists of TypeScript and native dependencies built with <code>node-gyp</code>. See <code>package.json</code> for various scripts for the developement process.</p>
<p>This repository consists of TypeScript and native dependencies built with <code>node-gyp</code>. See <code>package.json</code> for various scripts for the development process.</p>
<p>For first time building remember to <code>npm install</code></p>
<p>This repository uses git submodules. If paths are outdated or non-existent run <code>git submodule update --init --recursive</code></p>
<h2 id="install">Install</h2>
Expand All @@ -96,7 +96,7 @@ <h2 id="install">Install</h2>
<p><strong>EnPronouncer</strong> Pronounces a string, as a General English speaker, into its IPA string or array of Phones format.</p>
<p><strong>matchers</strong> module:</p>
<ul>
<li><p><strong>FuzzyMatcher</strong> Main use case for this library. Returns matches against a list of targets for a given query. The comparisions are not remembered and therefore better for one-off use cases.</p>
<li><p><strong>FuzzyMatcher</strong> Main use case for this library. Returns matches against a list of targets for a given query. The comparisons are not remembered and therefore better for one-off use cases.</p>
</li>
<li><p><strong>AcceleratedFuzzyMatcher</strong> Same interface as <code>FuzzyMatcher</code> but the list of targets are precomputed, so beneficial for multiple queries at the cost of a higher initialization time.</p>
</li>
Expand Down Expand Up @@ -210,7 +210,7 @@ <h3 id="typescript-transpiling">TypeScript Transpiling</h3>
<span class="hljs-comment"># For incremental builds.</span>
JOBS=X npm run build</code></pre>
<h2 id="test">Test</h2>
<pre><code class="language-py"><span class="hljs-comment"># Requires native depedencies built, but TypeScript transpiling not required.</span>
<pre><code class="language-py"><span class="hljs-comment"># Requires native dependencies built, but TypeScript transpiling not required.</span>
npm test</code></pre>
<h2 id="docs">Docs</h2>
<pre><code class="language-py"><span class="hljs-comment"># Generate the doc files from the docstrings.</span>
Expand All @@ -219,8 +219,8 @@ <h2 id="release">Release</h2>
<pre><code class="language-py"><span class="hljs-comment"># Builds everything, TypeScript &amp; native &amp; docs, as a release build.</span>
npm run release</code></pre>
<h2 id="deployment-upload">Deployment/Upload</h2>
<p>Note that the .js library code and native dependencies will be deployed separately. Npm regsitries will be used for the .js code, <code>node-pre-gyp</code> will be used for prebuilt dependencies while falling back to building on the client.</p>
<pre><code class="language-py"><span class="hljs-comment"># Pushes pack to npmjs.com or a private registry if a .npmrc exisits.</span>
<p>Note that the .js library code and native dependencies will be deployed separately. Npm registries will be used for the .js code, <code>node-pre-gyp</code> will be used for prebuilt dependencies while falling back to building on the client.</p>
<pre><code class="language-py"><span class="hljs-comment"># Pushes pack to npmjs.com or a private registry if a .npmrc exists.</span>
npm publish</code></pre>
<pre><code class="language-py"><span class="hljs-comment"># Packages a ./build/stage/{version}/maluubaspeech-{node_abi}-{platform}-{arch}.tar.gz.</span>
<span class="hljs-comment"># See package.json:binary.host on where to put it.</span>
Expand Down
61 changes: 25 additions & 36 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "phoneticmatching",
"version": "0.3.0",
"version": "0.3.1",
"description": "A text utility to do string comparisons at a phonetic level.",
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
Expand Down Expand Up @@ -34,13 +34,13 @@
"node-pre-gyp"
],
"devDependencies": {
"@types/jest": "^23.3.2",
"@types/node": "^10.11.3",
"@types/jest": "^23.3.9",
"@types/node": "^10.12.2",
"@types/xregexp": "^3.0.29",
"jest": "^23.6.0",
"ts-jest": "^23.10.3",
"ts-jest": "^23.10.4",
"typedoc": "^0.12.0",
"typescript": "^3.1.1"
"typescript": "^3.1.6"
},
"dependencies": {
"node-pre-gyp": "^0.11.0",
Expand Down

0 comments on commit 13f18f1

Please sign in to comment.