Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
version: 2.1

executors:
node-docker-executor:
docker:
- image: cimg/node:18.20.4-browsers
working_directory: ~/project

jobs:
# Job to publish to npm
npm-publish:
executor: node-docker-executor
steps:
- checkout
- run:
name: Install dependencies
command: yarn install # Ensure all dependencies are installed, including webpack
- run:
name: Set Up npm Credentials
command: |
echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > ~/.npmrc
- run:
name: Publish to npm
command: |
npm publish

workflows:
version: 2
publish:
jobs:
- npm-publish
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.md
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

# IDE
.vscode
.idea

# Lib
/dist
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# @modusbox/microfrontend-utils
# @pm4ml/microfrontend-utils

A collection of Typescript utilities for the frontend apps.

To install the module run `yarn add @modusbox/microfrontend-utils`.
To install the module run `yarn add @pm4ml/microfrontend-utils`.

Documentation is available at [https://modusintegration.github.io/microfrontend-utils](https://modusintegration.github.io/microfrontend-utils)
Documentation is available at [https://github.com/pm4ml/microfrontend-utils](https://github.com/pm4ml/microfrontend-utils)

### Development

Expand Down
9 changes: 6 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "@modusbox/microfrontend-utils",
"version": "0.0.3",
"name": "@pm4ml/microfrontend-utils",
"version": "0.0.5",
"main": "lib/index.js",
"license": "MIT",
"license": "Apache-2.0",
"author": "Ivan Annovazzi <[email protected]>",
"types": "lib/index.d.ts",
"files": [
Expand All @@ -11,6 +11,9 @@
"dependencies": {
"lodash": "^4.17.21"
},
"publishConfig": {
"access": "public"
},
"devDependencies": {
"@babel/core": "^7.13.16",
"@babel/preset-env": "^7.13.15",
Expand Down
18 changes: 9 additions & 9 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# @modusbox/microfrontend-utils
# @pm4ml/microfrontend-utils

A collection of Typescript utilities for the frontend apps.

### Installation

To install the module simply run `yarn add @modusbox/microfrontend-utils`.
To install the module simply run `yarn add @pm4ml/microfrontend-utils`.

### Usage

```ts
// import everything
import * as utils from '@modusbox/microfrontend-utils';
import * as utils from '@pm4ml/microfrontend-utils';
await utils.async.sleep(10);

// import all from module
import * as async from '@modusbox/microfrontend-utils/lib/async';
import * as async from '@pm4ml/microfrontend-utils/lib/async';
await async.sleep(10);

// import from module as named export
import { sleep } from '@modusbox/microfrontend-utils/lib/async';
// import from module as named export
import { sleep } from '@pm4ml/microfrontend-utils/lib/async';
await sleep(10);

// import a single utility
import sleep from '@modusbox/microfrontend-utils/lib/async/sleep';
import sleep from '@pm4ml/microfrontend-utils/lib/async/sleep';
await sleep(10);

// import a type
import { TextFileContent } from '@modusbox/microfrontend-utils/lib/file';
import { TextFileContent } from '@pm4ml/microfrontend-utils/lib/file';
```

Modules available:

- [async](./async/README.md)
- [async](./async/README.md)
Loading