Skip to content

Commit

Permalink
chore: update package and scope naming
Browse files Browse the repository at this point in the history
  • Loading branch information
seungok Jeong committed Jun 1, 2024
1 parent a1a0699 commit ae7aea7
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: skylight-utils tests
name: utils tests

on:
push:
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
## skylight-utils
## @puresky/utils

Typescript, Javascript utility collection

![npm](https://img.shields.io/npm/v/skylight-utils) ![skylight-utils tests](https://github.com/vsnm25/skylight-utils/actions/workflows/main.yml/badge.svg) [![tree-shaking](https://badgen.net/bundlephobia/tree-shaking/skylight-utils)](https://bundlephobia.com/result?p=skylight-utils) ![npm](https://img.shields.io/npm/dw/skylight-utils) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/skylight-utils)
![npm](https://img.shields.io/npm/v/@puresky/utils) ![@puresky/utils tests](https://github.com/vsnm25/utils/actions/workflows/main.yml/badge.svg) [![tree-shaking](https://badgen.net/bundlephobia/tree-shaking/@puresky/utils)](https://bundlephobia.com/result?p=@puresky/utils) ![npm](https://img.shields.io/npm/dw/@puresky/utils) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@puresky/utils)


## Installation
```shell
## npm
npm install skylight-utils
npm install @puresky/utils

## yarn
yarn add skylight-utils
yarn add @puresky/utils
```


## API Documentation
You can check entire api documentation in [here](https://github.com/vsnm25/skylight-utils/blob/main/README_API.md)
You can check entire api documentation in [here](https://github.com/vsnm25/utils/blob/main/README_API.md)

8 changes: 4 additions & 4 deletions README_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

| API | API spec |
| -- | -- |
| deepClone | [deepClone.md](https://github.com/vsnm25/skylight-utils/blob/main/src/deepClone.md) |
| hexToRgba | [hexToRgba.md](https://github.com/vsnm25/skylight-utils/blob/main/src/hexToRgba.md) |
| isEmptyObject | [isEmptyObject.md](https://github.com/vsnm25/skylight-utils/blob/main/src/isEmptyObject.md) |
| minMaxBetween | [minMaxBetween.md](https://github.com/vsnm25/skylight-utils/blob/main/src/minMaxBetween.md) |
| deepClone | [deepClone.md](https://github.com/vsnm25/utils/blob/main/src/deepClone.md) |
| hexToRgba | [hexToRgba.md](https://github.com/vsnm25/utils/blob/main/src/hexToRgba.md) |
| isEmptyObject | [isEmptyObject.md](https://github.com/vsnm25/utils/blob/main/src/isEmptyObject.md) |
| minMaxBetween | [minMaxBetween.md](https://github.com/vsnm25/utils/blob/main/src/minMaxBetween.md) |
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
"author": "vsnm25 <vsnm25@gmail.com> (https://github.com/vsnm25)",
"license": "MIT",
"description": "Typescript, Javascript utility collection",
"homepage": "https://github.com/vsnm25/skylight-utils",
"homepage": "https://github.com/vsnm25/utils",
"bugs": {
"url": "https://github.com/vsnm25/skylight-utils/issues"
"url": "https://github.com/vsnm25/utils/issues"
},
"keywords": [
"typescript",
Expand Down
2 changes: 1 addition & 1 deletion scripts/updateApiDocumentation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ const updateApiDocumentation = async () => {
for (let i = 0; i < utilityReadmeList.length; i += 1) {
const utilityReadme = utilityReadmeList[i];
const utilityName = utilityReadme.split(".md")[0];
API_DOCUMENTATION_TEMPLATE += `| ${utilityName} | [${utilityReadme}](https://github.com/vsnm25/skylight-utils/blob/main/src/${utilityReadme}) | \n`;
API_DOCUMENTATION_TEMPLATE += `| ${utilityName} | [${utilityReadme}](https://github.com/vsnm25/utils/blob/main/src/${utilityReadme}) | \n`;
}
fs.writeFile("README_API.md", API_DOCUMENTATION_TEMPLATE);
} catch (err) {
Expand Down
2 changes: 1 addition & 1 deletion src/deepClone.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ function deepClone<T>(value: T): T;

## Usage
```typescript
import { deepClone } from 'skylight-utils';
import { deepClone } from '@puresky/utils';

const originManky = { manky: { banana: 1 } };
const deepCopiedManky = deepClone(originManky);
Expand Down
2 changes: 1 addition & 1 deletion src/hexToRgba.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ function hexToRgba(hexColor: string, alpha?: number): string;

## Usage
```typescript
import { hexToRgba } from 'skylight-utils';
import { hexToRgba } from '@puresky/utils';

const green = hexToRgba("#5eba7d"); // rgba(94, 186, 125, 1)
const lightGreen = hexToRgba("#5eba7d", 0.5); // rgba(94, 186, 125, 0.5)
Expand Down
2 changes: 1 addition & 1 deletion src/isEmptyObject.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ function isEmptyObject(value: unknown): boolean;

## Usage
```typescript
import { isEmptyObject } from 'skylight-utils';
import { isEmptyObject } from '@puresky/utils';

console.log(isEmptyObject({})); // true
```

0 comments on commit ae7aea7

Please sign in to comment.