Skip to content

Commit b562186

Browse files
MrDHatMrDHat
authored
Change Package Name & Publish Script (#1)
Change Package Name & Publish Script
2 parents b578830 + 6abfb1f commit b562186

File tree

11 files changed

+68
-47
lines changed

11 files changed

+68
-47
lines changed

‎.github/workflows/nodejs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ jobs:
2121
run: |
2222
npm i -g yarn
2323
yarn install
24-
yarn test
24+
yarn test:ci
2525
env:
2626
CI: true
2727
REACT_APP_PUBLIC_KEY: ${{ secrets.ik_public_key }}

‎.github/workflows/npmpublish.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ jobs:
2424
run: |
2525
npm i -g yarn
2626
yarn install
27-
yarn test
27+
yarn test:ci
2828
env:
2929
CI: true
30-
31-
publish:
30+
31+
publish:
3232
needs: build
3333
runs-on: ubuntu-latest
3434
steps:
@@ -41,7 +41,7 @@ jobs:
4141
run: |
4242
npm i -g yarn
4343
yarn config set //registry.npmjs.org/:_authToken=$NODE_AUTH_TOKEN
44-
yarn publish
44+
yarn publish
4545
env:
4646
NODE_AUTH_TOKEN: ${{secrets.npm_token}}
4747
CI: true

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ImageKit.io React SDK
22

3-
[![Node CI](https://github.com/imagekit-developer/imagekit-nodejs/workflows/Node%20CI/badge.svg)](https://github.com/imagekit-developer/imagekit-react/)
4-
[![npm version](https://img.shields.io/npm/v/imagekit-react)](https://www.npmjs.com/package/imagekit-react)
3+
[![Node CI](https://github.com/imagekit-developer/imagekit-nodejs/workflows/Node%20CI/badge.svg)](https://github.com/imagekit-developer/imagekitio-react/)
4+
[![npm version](https://img.shields.io/npm/v/imagekitio-react)](https://www.npmjs.com/package/imagekitio-react)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
66
[![Twitter Follow](https://img.shields.io/twitter/follow/imagekitio?label=Follow&style=social)](https://twitter.com/ImagekitIo)
77

@@ -11,11 +11,11 @@ ImageKit is a complete image optimization and transformation solution that comes
1111

1212
## Installation
1313

14-
`npm install --save imagekit-react`
14+
`npm install --save imagekitio-react`
1515

1616
Include the components in your code:
1717

18-
`import {IKContext} from "imagekit-react"`
18+
`import {IKContext} from "imagekitio-react"`
1919

2020
## Usage
2121

‎package-lock.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
{
2-
"name": "imagekit-react",
2+
"name": "imagekitio-react",
33
"version": "1.0.0",
44
"description": "React SDK for ImageKit.io which implements client-side upload and URL generation for use inside a react application.",
55
"private": true,
66
"scripts": {
7+
"compile": "node_modules/.bin/babel src --out-dir lib --copy-files",
8+
"dist": "node_modules/.bin/webpack",
9+
"build": "rm -f -r compile && npm run compile && rm -f -r dist && npm run dist",
10+
"test:ci": "react-scripts test -u --env=jsdom --watchAll=false",
711
"test": "react-scripts test -u --env=jsdom --watchAll",
812
"storybook": "start-storybook -p 6007",
9-
"compile": "node_modules/.bin/babel src --out-dir lib --copy-files ",
10-
"dist": "node_modules/.bin/webpack",
11-
"build-storybook": "build-storybook",
12-
"build": "rm -f -r compile && npm run compile && rm -f -r dist && npm run dist"
13+
"build-storybook": "build-storybook"
1314
},
1415
"repository": {
1516
"type": "git",
16-
"url": "git@gitlab.com:mindship/imagekit/imagekit-react.git"
17+
"url": "https://github.com/imagekit-developer/imagekit-react"
1718
},
18-
"main": "dist/imagekit-react.js",
19+
"main": "dist/imagekitio-react.js",
1920
"author": "ImageKit",
2021
"license": "ISC",
2122
"devDependencies": {

‎samples/sample-app/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Now link it with, npm link
2525
```js
2626
npm link
2727
```
28-
This will create a global repository link for imagekit-react
28+
This will create a global repository link for imagekitio-react
2929

3030

3131
### Installing the sample-app
@@ -43,10 +43,10 @@ npm install
4343

4444
Now run,
4545
```js
46-
npm link imagekit-react
46+
npm link imagekitio-react
4747
```
4848

49-
This should create a copy of `imagekit-react` library in `node_modules` of `sample-app`
49+
This should create a copy of `imagekitio-react` library in `node_modules` of `sample-app`
5050

5151
## Setting the enviroment variable
5252

‎samples/sample-app/src/App.js‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
11
import React from 'react';
22
import './App.css';
3-
import { IKImage, IKContext, IKUpload } from 'imagekit-react'
3+
import { IKImage, IKContext, IKUpload } from 'imagekitio-react'
44
function App() {
55
const publicKey = process.env.REACT_APP_PUBLIC_KEY;
6-
const urlEndpoint = process.env.REACT_APP_URL_ENDPOINT;
6+
let urlEndpoint = process.env.REACT_APP_URL_ENDPOINT;
7+
if(urlEndpoint[urlEndpoint.length-1] === "/")
8+
urlEndpoint = urlEndpoint.slice(0,urlEndpoint.length-1);
9+
710
const authenticationEndpoint = process.env.REACT_APP_AUTHENTICATION_ENDPOINT;
811

12+
let path = "/default-image.jpg";
13+
if(path[0] === "/")
14+
path = path.split("/")[1];
15+
16+
const src = `${urlEndpoint}/${path}`;
17+
918
return (
1019
<div className="App">
1120
<h1>Hi! This is an ImageKit React SDK Demo!</h1>
1221
<p>Let's add an Image</p>
13-
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} src="https://ik.imagekit.io/gqyojxcwzxj/ABC_BV8lzpfOS" />
22+
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} src={src} />
1423
<p>Let's transform this once</p>
15-
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} src="https://ik.imagekit.io/gqyojxcwzxj/ABC_BV8lzpfOS" transformation={[{
24+
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} src={src} transformation={[{
1625
"height": "200",
1726
"width": "200"
1827
}]} />
1928
<p>Let's transform this more than once</p>
20-
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} path="/ABC_BV8lzpfOS" transformation={[{
29+
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} path={path} transformation={[{
2130
"height": "200",
2231
"width": "200",
2332
},
@@ -26,14 +35,14 @@ function App() {
2635
}]} />
2736
<p>Adding a Image with Context</p>
2837
<IKContext publicKey={publicKey} urlEndpoint={urlEndpoint} >
29-
<IKImage path="/ABC_BV8lzpfOS" transformation={[{
38+
<IKImage path={path} transformation={[{
3039
"height": "300",
3140
"width": "400"
3241
}]} />
3342
</IKContext>
3443
<p>LQIP</p>
3544
<IKContext publicKey={publicKey} urlEndpoint={urlEndpoint} >
36-
<IKImage path="/ABC_BV8lzpfOS" lqip={{ active: true, quality: 30 }} />
45+
<IKImage path={path} lqip={{ active: true, quality: 30 }} />
3746
</IKContext>
3847
<p>Upload</p>
3948
<IKContext publicKey={publicKey} urlEndpoint={urlEndpoint} authenticationEndpoint={authenticationEndpoint} >
@@ -45,3 +54,4 @@ function App() {
4554
}
4655

4756
export default App;
57+

‎src/test/stories/0-Image.stories.js‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,15 @@ import { storiesOf } from "@storybook/react";
44
import ErrorBoundary from "../../components/ErrorBoundary"
55

66
const publicKey = process.env.REACT_APP_PUBLIC_KEY;
7-
const urlEndpoint = process.env.REACT_APP_URL_ENDPOINT;
7+
let urlEndpoint = process.env.REACT_APP_URL_ENDPOINT;
8+
if(urlEndpoint[urlEndpoint.length-1] === "/")
9+
urlEndpoint = urlEndpoint.slice(0,urlEndpoint.length-1);
10+
11+
let path = "/default-image.jpg";
12+
if(path[0] === "/")
13+
path = path.split("/")[1];
14+
15+
const src = `${urlEndpoint}${path}`;
816

917
global.IntersectionObserver = class IntersectionObserver {
1018
constructor() {}
@@ -20,20 +28,20 @@ storiesOf("Image", module)
2028
.add(
2129
"image",
2230
() =>
23-
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} src="https://ik.imagekit.io/gqyojxcwzxj/ABC_BV8lzpfOS"/>
31+
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} src={src}/>
2432
)
2533
.add(
2634
"imageWithLQIP",
2735
() =>
28-
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} lqip={{active:true, quality: 20}} src="https://ik.imagekit.io/gqyojxcwzxj/ABC_BV8lzpfOS" transformation={[{
36+
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} lqip={{active:true, quality: 20}} src={src} transformation={[{
2937
height: 300,
3038
width: 400
3139
}]} id="lqip"/>
3240
)
3341
.add(
3442
"imageWithTransformations",
3543
() =>
36-
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} src="https://ik.imagekit.io/gqyojxcwzxj/ABC_BV8lzpfOS" transformation={[{
44+
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} src={src} transformation={[{
3745
height: 300,
3846
width: 400
3947
}]} />
@@ -53,7 +61,7 @@ storiesOf("Image", module)
5361
"imagePublicKeyFail",
5462
() =>
5563
<ErrorBoundary>
56-
<IKImage urlEndpoint={urlEndpoint} path="/ABC_BV8lzpfOS" transformation={[{
64+
<IKImage urlEndpoint={urlEndpoint} path={path} transformation={[{
5765
"heigth": "300",
5866
"width": "400"
5967
}]} />
@@ -64,7 +72,7 @@ storiesOf("Image", module)
6472
"imageUrlEndpointFail",
6573
() =>
6674
<ErrorBoundary>
67-
<IKImage publicKey="public_oeVQ1TDolFID06vH0h6yMUeqjLY=" path="/ABC_BV8lzpfOS" transformation={[{
75+
<IKImage publicKey="public_oeVQ1TDolFID06vH0h6yMUeqjLY=" path={path} transformation={[{
6876
"height": "300",
6977
"width": "400"
7078
}]} />

‎src/test/stories/1-Image-Transformation.stories.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,21 @@ import { storiesOf } from "@storybook/react";
44

55
const publicKey = process.env.REACT_APP_PUBLIC_KEY;
66
const urlEndpoint = process.env.REACT_APP_URL_ENDPOINT;
7+
const path = "/default-image.jpg";
78

89
storiesOf("Image-Transformation", module)
910
.add(
1011
"imageWithSingleTransformations",
1112
() =>
12-
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} path="ABC_BV8lzpfOS" transformation={[{
13+
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} path={path} transformation={[{
1314
"height": "300",
1415
"width": "400"
1516
}]} />
1617
)
1718
.add(
1819
"imageWithChainedTransformations",
1920
() =>
20-
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} path="/ABC_BV8lzpfOS" transformation={[{
21+
<IKImage publicKey={publicKey} urlEndpoint={urlEndpoint} path={path} transformation={[{
2122
"height": "300",
2223
"width": "400"
2324
}, {

‎src/test/stories/2-ImageKitContext.stories.js‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,14 @@ import ErrorBoundary from "../../components/ErrorBoundary";
66

77
const publicKey = process.env.REACT_APP_PUBLIC_KEY;
88
const urlEndpoint = process.env.REACT_APP_URL_ENDPOINT;
9+
const path = "default-image.jpg";
910

1011
storiesOf("IKContext", module)
1112
.add(
1213
"imageKitContext",
1314
() =>
1415
<IKContext publicKey={publicKey} urlEndpoint={urlEndpoint} >
15-
<IKImage path="/ABC_BV8lzpfOS" transformation={[{
16+
<IKImage path={path} transformation={[{
1617
"height": "300",
1718
"width": "400"
1819
}]} />
@@ -23,7 +24,7 @@ storiesOf("IKContext", module)
2324
() =>
2425
<ErrorBoundary>
2526
<IKContext urlEndpoint={urlEndpoint} >
26-
<IKImage path="/ABC_BV8lzpfOS" transformation={[{
27+
<IKImage path={path} transformation={[{
2728
"height": "300",
2829
"width": "400"
2930
}]} />

0 commit comments

Comments
 (0)