https://github.com/moderne/moderne

The Side-To-IDE Developer Tool To Manage Contents Of Packages Expressed As Maps Of Code, Docs and Tests On Function Level; Elimintate Plumbing By Facsilitating Maintanance Of Abstract Package Structure; Build Packages With Closure For Publishing; Synchronise With Remote Source Control; Support Templates For Modern Node.js Apps; Deploy API As Serverless Functions.
https://github.com/moderne/moderne

build closue coverage doc documentation examples ide node-js plumbing serverless test

Last synced: 5 days ago
JSON representation

The Side-To-IDE Developer Tool To Manage Contents Of Packages Expressed As Maps Of Code, Docs and Tests On Function Level; Elimintate Plumbing By Facsilitating Maintanance Of Abstract Package Structure; Build Packages With Closure For Publishing; Synchronise With Remote Source Control; Support Templates For Modern Node.js Apps; Deploy API As Serverless Functions.

• Host: GitHub
• URL: https://github.com/moderne/moderne
• Owner: moderne
• License: mit
• Created: 2018-11-02T09:37:44.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-11-02T09:48:15.000Z (about 6 years ago)
• Last Synced: 2024-09-29T13:47:45.348Z (about 2 months ago)
• Topics: build, closue, coverage, doc, documentation, examples, ide, node-js, plumbing, serverless, test
• Language: JavaScript
• Homepage: https://moderne.app
• Size: 16.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @moderne/moderne

[![npm version](https://badge.fury.io/js/@moderne/moderne.svg)](https://npmjs.org/package/@moderne/moderne)

`@moderne/moderne` is The Side-To-IDE Developer Tool To Manage Contents Of Packages Expressed As Maps Of Code, Docs and Tests On Function Level; Elimintate Plumbing By Facsilitating Maintanance Of Abstract Package Structure; Build Packages With Closure For Publishing; Synchronise With Remote Source Control; Support Templates For Modern Node.js Apps; Deploy API As Serverless Functions.

```sh

yarn add -E @moderne/moderne

```

## Table Of Contents

- [Table Of Contents](#table-of-contents)

- [API](#api)

- [`moderne(arg1: string, arg2?: boolean)`](#mynewpackagearg1-stringarg2-boolean-void)

  * [`Config`](#type-config)

- [Copyright](#copyright)



## API

The package is available by importing its default function:

```js

import moderne from '@moderne/moderne'

```



## `moderne(`
  `arg1: string,`
  `arg2?: boolean,`
`): void`

Call this function to get the result you want.

__`Config`__: Options for the program.

|   Name    |   Type    |    Description    | Default |

| --------- | --------- | ----------------- | ------- |

| shouldRun | _boolean_ | A boolean option. | `true`  |

| __text*__ | _string_  | A text to return. | -       |

```js

/* yarn example/ */

import moderne from '@moderne/moderne'

(async () => {

  const res = await moderne({

    text: 'example',

  })

  console.log(res)

})()

```

```

example

```



## Copyright

(c) [Moderne][1] 2018

[1]: https://moderne.app