Skip to content

Commit 983fb4b

Browse files
authored
rename renaming package name (#427)
1 parent 6f49583 commit 983fb4b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+189
-186
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Pull request for @cloudinary/js-url-gen
1+
### Pull request for @cloudinary/url-gen
22

33

44
#### What does this PR solve?

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Breaking changes
128128

129129
Other changes
130130
================
131-
* Docs - Fix styling in the search component when searching for @cloudinary/js-url-gen (#338)
131+
* Docs - Fix styling in the search component when searching for @cloudinary/url-gen (#338)
132132
* Docs - Change wording of SDK Summary when searching (#337)
133133
* Build - Set the bundle target to ES6 for ESM, and ES5 for UMD (#335)
134134
* Docs - Enhance the search

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ This SDK can also be used with [popular frontend frameworks](https://cloudinary.
1414

1515
## Installation
1616
```bash
17-
npm install @cloudinary/js-url-gen
17+
npm install @cloudinary/url-gen
1818
```
1919

2020
## Simple usage
2121
```javascript
2222

2323
// Import the Cloudinary class
24-
import {Cloudinary} from '@cloudinary/js-url-gen';
24+
import {Cloudinary} from '@cloudinary/url-gen';
2525

2626
// Create your instance
2727
const cld = new Cloudinary({
@@ -35,7 +35,7 @@ const cld = new Cloudinary({
3535

3636
// Let's create a new image
3737
const myImage = cld.image('sample');
38-
import {Resize} from '@cloudinary/js-url-gen/actions/resize';
38+
import {Resize} from '@cloudinary/url-gen/actions/resize';
3939
myImage.resize(Resize.scale().width(100).height(100));
4040

4141
// When we're done, we can apply all our changes and create a URL.
@@ -56,22 +56,22 @@ console.log(myURL);
5656

5757

5858
### Transpilation
59-
@cloudinary/js-url-gen is shipped as untranspiled ES6 code.
60-
@cloudinary/js-url-gen is optimized around bundle size, as such we do not transpile our distributed modules,
59+
@cloudinary/url-gen is shipped as untranspiled ES6 code.
60+
@cloudinary/url-gen is optimized around bundle size, as such we do not transpile our distributed modules,
6161
we leave the decision of what browsers to support, and what transpilations to apply, to you, the user.
6262

6363
### Testing with Jest
6464

65-
As mentioned above, we're shipping @cloudinary/js-url-gen with ES6 code, as this provides great tree-shaking potential.
65+
As mentioned above, we're shipping @cloudinary/url-gen with ES6 code, as this provides great tree-shaking potential.
6666
it also requires a few adjustments when testing.
6767

6868
In jest.config, you'll need to add these lines to allow babel to transpile our code.
6969
```json
7070
{
7171
"transform": {
72-
"node_modules/@cloudinary/js-url-gen": "babel-jest"
72+
"node_modules/@cloudinary/url-gen": "babel-jest"
7373
},
74-
"transformIgnorePatterns": ["/node_modules/(?!@cloudinary/js-url-gen)"]
74+
"transformIgnorePatterns": ["/node_modules/(?!@cloudinary/url-gen)"]
7575
}
7676
```
7777
Make sure to install babel-jest:

__DOCS__/examples/annotatedExamples/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
```javascript
44
// Import the cloudinary class
5-
import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary";
5+
import {Cloudinary} from "@cloudinary/url-gen/instance/Cloudinary";
66

77
// Create your instance
88
const cld = new Cloudinary({

__DOCS__/examples/annotatedExamples/imageOverlay.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
```javascript
22
// Import the cloudinary class
3-
import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary";
3+
import {Cloudinary} from "@cloudinary/url-gen/instance/Cloudinary";
44

55
// Create your instance
66
const cld = new Cloudinary({
@@ -17,18 +17,18 @@ const myImage = cld.image('sample');
1717

1818
// An overlay is built from several parts
1919
// Import video or image overlay, based on your asset
20-
import {Overlay} from "@cloudinary/js-url-gen/actions/overlay";
20+
import {Overlay} from "@cloudinary/url-gen/actions/overlay";
2121
// Import the source of the layer, this determines if the layer is an image, text or video
22-
import {image} from "@cloudinary/js-url-gen/qualifiers/source";
22+
import {image} from "@cloudinary/url-gen/qualifiers/source";
2323

2424
// Import how to position your layer
25-
import {Position} from "@cloudinary/js-url-gen/qualifiers/position";
26-
import {southEast} from "@cloudinary/js-url-gen/qualifiers/compass";
27-
import {compass} from "@cloudinary/js-url-gen/qualifiers/gravity";
25+
import {Position} from "@cloudinary/url-gen/qualifiers/position";
26+
import {southEast} from "@cloudinary/url-gen/qualifiers/compass";
27+
import {compass} from "@cloudinary/url-gen/qualifiers/gravity";
2828

2929
// We'll also scale our overlay, we'll need this for later.
30-
import {scale} from "@cloudinary/js-url-gen/actions/resize";
31-
import {Transformation} from "@cloudinary/js-url-gen/transformation/Transformation";
30+
import {scale} from "@cloudinary/url-gen/actions/resize";
31+
import {Transformation} from "@cloudinary/url-gen/transformation/Transformation";
3232

3333

3434
myImage.overlay(

__DOCS__/examples/annotatedExamples/resize.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
```javascript
22
// Import the cloudinary class
3-
import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary";
3+
import {Cloudinary} from "@cloudinary/url-gen/instance/Cloudinary";
44

55
// Create your instance
66
const cld = new Cloudinary({
@@ -26,9 +26,9 @@ const myImage = cld.image('sample');
2626

2727
// the resize() ActionGroup needs an Action parameter
2828
// Lets give resize() a ResizeScale paramter to scale our image
29-
// We import all of our Action parameters from @cloudinary/js-url-gen/actions/{actionGroup}
29+
// We import all of our Action parameters from @cloudinary/url-gen/actions/{actionGroup}
3030
// Note that you can import all Resize Actions, or just the single one you want
31-
import {Resize} from "@cloudinary/js-url-gen/actions/resize";
31+
import {Resize} from "@cloudinary/url-gen/actions/resize";
3232
const {scale} = Resize;
3333
// Resize.scale === scale
3434
// Explore the Resize object to discover more resize actions

__DOCS__/examples/annotatedExamples/rotate.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary";
2+
import {Cloudinary} from "@cloudinary/url-gen/instance/Cloudinary";
33

44
const cld = new Cloudinary({
55
cloud: {
@@ -12,18 +12,18 @@ const cld = new Cloudinary({
1212

1313

1414
// Import the RotationModeAction
15-
import {mode} from '@cloudinary/js-url-gen/actions/rotate';
15+
import {mode} from '@cloudinary/url-gen/actions/rotate';
1616

1717
// Remember, mode is a function that returns an Action
1818
// but we refer to both as a RotationMode action
1919

2020
// The RotationModeAction (mode) requires a Qualifier
2121
// That qualifier will require a certain QualifierValue
2222
// To make life easier, you can import all possible QualifierValue(s) of rotate
23-
import {RotationMode} from '@cloudinary/js-url-gen/qualifiers/rotationMode';
23+
import {RotationMode} from '@cloudinary/url-gen/qualifiers/rotationMode';
2424

2525
// You can also import only the required QualifierValue you want
26-
import {verticalFlip} from '@cloudinary/js-url-gen/qualifiers/rotationMode';
26+
import {verticalFlip} from '@cloudinary/url-gen/qualifiers/rotationMode';
2727
// RotationMode.verticalFlip === verticalFlip
2828

2929
const myImage = cld.image('sample');

__DOCS__/examples/gettingStarted/helloworld.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
<h2>Code Example</h2>
44

55
```javascript
6-
import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary";
7-
import {scale} from "@cloudinary/js-url-gen/actions/resize";
6+
import {Cloudinary} from "@cloudinary/url-gen/instance/Cloudinary";
7+
import {scale} from "@cloudinary/url-gen/actions/resize";
88

99
// Create your instance
1010
const cld = new Cloudinary({
@@ -38,7 +38,7 @@ const myURL = myImage.toURL();
3838
<li>Creates a new Cloudinary instance, with a set of configurations</li>
3939
<li>Instructs your instance to work with a Cloudinary Image (CloudinaryImage)</li>
4040
<li>Creates a new CloudinaryImage instance with a publicID of 'sample' (<code>cld.image('sample')</code>)</li>
41-
<li>Imports the <code>scale()</code> Action from <code>'@cloudinary/js-url-gen/actions/resize'</code> </li>
41+
<li>Imports the <code>scale()</code> Action from <code>'@cloudinary/url-gen/actions/resize'</code> </li>
4242
<li>Uses the Action methods <code>width</code> and <code>height</code> to set the scale size</li>
4343
<li>Applies your changes and creates a URL string</li>
4444
</ul>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<h1>Installation</h1>
22
<h3>Installing through npm</h3>
3-
<code> npm install @cloudinary/js-url-gen</code>
3+
<code> npm install @cloudinary/url-gen</code>

__DOCS__/examples/gettingStarted/terminology.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55

66
```javascript
7-
import {Cloudinary} from "@cloudinary/js-url-gen/instance/Cloudinary";
8-
import {Rotate} from "@cloudinary/js-url-gen/actions/rotate";
9-
import {Resize} from "@cloudinary/js-url-gen/actions/resize";
10-
import {RotationMode} from "@cloudinary/js-url-gen/qualifiers/rotationMode";
7+
import {Cloudinary} from "@cloudinary/url-gen/instance/Cloudinary";
8+
import {Rotate} from "@cloudinary/url-gen/actions/rotate";
9+
import {Resize} from "@cloudinary/url-gen/actions/resize";
10+
import {RotationMode} from "@cloudinary/url-gen/qualifiers/rotationMode";
1111

1212
// Create your instance
1313
const cld = new Cloudinary({
@@ -45,8 +45,8 @@ myImage
4545
<li>Assets expose methods called <b>ActionGroups</b> (<code>image.resize</code>, <code>image.rotate</code>)
4646
<li>ActionGroups receive an Action as a parameter
4747
<li>We create Action objects through Factory methods (<code>scale</code>, <code>mode</code>)
48-
<li>You can find more Actions in <code>'@cloudinary/js-url-gen/actions'</code>
49-
<li>You can import all actions from <code>import {Actions} from '@cloudinary/js-url-gen'</code>
48+
<li>You can find more Actions in <code>'@cloudinary/url-gen/actions'</code>
49+
<li>You can import all actions from <code>import {Actions} from '@cloudinary/url-gen'</code>
5050
</ul>
5151

5252

@@ -57,7 +57,7 @@ myImage
5757
<li>Qualifiers usually accept a <b>QualifierValue</b>
5858
<li>QualifierValues can be primitive (numbers, strings) or predefined SDK values that can be imported
5959
<li>Almost all QualifierValues are functions (RotationMode.verticalFlip())
60-
<li>You can find more QualifierValues in <code>'@cloudinary/js-url-gen/values'</code>
60+
<li>You can find more QualifierValues in <code>'@cloudinary/url-gen/values'</code>
6161
</ul>
6262

6363
<h4>Generalized form</h4>

0 commit comments

Comments
 (0)