@shyamsfo/simple-ts

v0.0.26

Published

a year ago

Hello World package to play with typescript

Downloads

0High
0Medium
0Low

shyamsfo

Introduction

What is this

Published a hello world module on npm following this:

https://whitep4nth3r.com/blog/how-to-build-test-and-release-node-module-es6

Installation and usage

First run:

yarn add @shyamsfo/simple-ts --save

Then, in your js file:

import s_ts from '@shyamsfo/simple-ts';
s_ts.random_str()
s_ts.random_int()
s_ts.current_time()

Using this in an html directly:

<!DOCTYPE html>
<html lang="en">
<head>
  <title> Loading our simple.js at the beginning</title>
    <script src="https://cdn.jsdelivr.net/npm/@shyamsfo/[email protected]/dist/simple_ts_bundle.min.js"></script>
</head>
<body class="" style="font-family: 'Source Sans Pro', sans-serif;">
<script>
  function callSimple() {
    // webpack.dev.js in simple build is setup to put the default export into simple3
    console.log(simple_ts.random_str());
    console.log(simple_ts.random_int());
    console.log(simple_ts.current_time());
    let ans = simple_ts.random_str();
    document.getElementById('s').innerHTML =  ans;
  }
</script>
Hello.World Load simple_ts<br/>
<button onclick="callSimple()">Click</button> <br/>
<hr/>
<div id="s"></div>
<div id="b"></div>
<hr/>
</body>
</html>

Development Setup

First clone the repo. Then run:

yarn install

Development

Run yarn dev to watch for changes and compile continously
yarn clean to clean resources
yarn types to generate types
yarn build to do a build.
yarn test to run tests

Once development is complete we are ready to publish. See below.

Publish

First commit all the code using git add . and git commit -m "Commit message"
Then run yarn publish
This will ask for new version number
package.json will be updated with new version number and a new commit will be done
prepublish will be run that will do the clean build
package will be published
git push (including tags) will be done.
Verify package has been published at https://www.npmjs.com/package/@shyamsfo/simple-ts

Setup

How to start a new npm package:

npm init --scope=@shyamsfo
<Development of all code>
npm login
npm publish --access public

Local testing from another node project

# in this directory
yarn link

In the client:

yarn link @shyamsfo/simple-ts

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme