https://github.com/oresoftware/ores

Command line tools for ORESoftware
https://github.com/oresoftware/ores

bash nodejs ores oresoftware shell

Last synced: about 1 month ago
JSON representation

Command line tools for ORESoftware

• Host: GitHub
• URL: https://github.com/oresoftware/ores
• Owner: ORESoftware
• License: mit
• Created: 2018-07-07T05:58:52.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-04T01:13:11.000Z (over 6 years ago)
• Last Synced: 2023-03-02T00:26:06.728Z (almost 2 years ago)
• Topics: bash, nodejs, ores, oresoftware, shell
• Language: Shell
• Size: 19.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        

## TSLS - TypeScript Library Skeleton




Travis build status:

[![Build Status](https://travis-ci.org/ORESoftware/typescript-library-skeleton.svg?branch=master)](https://travis-ci.org/ORESoftware/typescript-library-skeleton)




CircleCI build status:

[![CircleCI](https://circleci.com/gh/ORESoftware/typescript-library-skeleton/tree/master.svg?style=svg)](https://circleci.com/gh/ORESoftware/typescript-library-skeleton/tree/master)




# Your Project Readme Goes Here

This project is used by:

https://github.com/oresoftware/ts-project

You can use ts-project to do things more automatically.

To do things more manually, continue on.

Steps to making this project skeleton your own project base.

1. Clone this repo: 


    `git clone https://github.com/ORESoftware/typescript-library-skeleton.git YOUR-PROJECT-NAME`

2. Update package.json so that `name` property matches `YOUR-PROJECT-NAME`.

3. Update other package.json fields so that they are accurate.

To check to see if `YOUR-PROJECT-NAME` is available on NPM, uses this command at the command line:

`$ npm view YOUR-PROJECT-NAME`  # will give you a 404 if the name is available.

### This project skeleton uses:

* the correct semver initial value (npm init defaults to 1.0.0 which is just wrong).

* typescript 2.9.x

* nodejs version 10

* travis/circleci (for automated testing of your library)

* MIT license

* good simple default settings for .gitignore / .npmignore / .editorconfig / .gitattributes

* Transpiling from src to dist folders (by default; you can change it manually)

To transpile files in place, instead of tranpiling from `'src'` to `'dist'`:




update tsconfig.json  (remove the `outDir` line):

```json

"compilerOptions": {

    "outDir": "dist"

}

```

For small projects with just one .ts/.js file, you can just get rid of the src/lib folder, and put your index.ts

file in the root of the project. In that case, make sure to change the `main` property in package.json from 'lib/index.js' to

'index.js'. Same with the `typings/types` properties.