feat: rename blocks from lr to uc #698

egordidenko · 2024-07-15T16:54:56Z

Description

Checklist

Tests (if applicable)
Documentation (if applicable)
Changelog stub (or use conventional commit messages)

Summary by CodeRabbit

New Features
- Updated documentation to reflect the new naming convention from "LR" to "UC" across various components and references.
- Enhanced component templates and styles to align with the new "UC" prefix, improving consistency.
Bug Fixes
- Resolved inconsistencies in component references that may have caused issues during rendering.
Documentation
- Comprehensive updates to README and demo files to support the new naming scheme, ensuring clarity for users.
Style
- Renamed CSS classes and identifiers to follow the "uc-" prefix convention for improved branding and clarity.
Chores
- Updated build configurations and paths to match the new naming conventions.

coderabbitai · 2024-07-15T16:55:04Z

Caution

Review failed

The pull request is closed.

Walkthrough

The recent updates involve a comprehensive renaming effort, shifting from the "LR" prefix to "UC" across the documentation, components, and styling files. This change enhances consistency and clarity throughout the codebase, standardizing references to components and maintaining compatibility with the new naming convention. Overall, the modifications streamline the structure while preserving the functionality of the components involved.

Changes

Files and Directories	Change Summary
`README.md`	Renamed references from "LR" to "UC" in imports, HTML tags, and configurations.
`abstract/.js`, `blocks/.js`, `blocks/.css`, `types/.d.ts`	Updated class names, HTML elements, and CSS selectors from "lr-" to "uc-".
`demo/*.html`	Changed imported modules and references from "LR" to "UC".
`build-items.js`, `build-svg-sprite.js`, `build.js`	Modified build configurations and paths to reflect new "UC" naming.
`solutions/*`	Updated component registrations and imports to align with the new "UC" naming convention.
`types/test/*.test-d.tsx`	Replaced instances of components prefixed with "lr-" with "uc-" in test files.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UC_Component as UC Component
    participant UC_Config as UC Config
    User->>UC_Component: Use UC component
    UC_Component->>UC_Config: Retrieve configuration
    UC_Config-->>UC_Component: Provide settings
    UC_Component-->>User: Render output

🐇 "In fields of green, we hop with glee,
The 'UC' change is now a spree!
From 'LR' to 'UC', we dance and play,
A brighter path shines this fine day!
With joy we celebrate, oh so spry,
For new beginnings, we leap high! 🌼"

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

nd0ut · 2024-07-16T14:39:26Z

abstract/Block.js

    if (!name) {
      super.reg();
      return;
    }
-    super.reg(name.startsWith(TAG_PREFIX) ? name : TAG_PREFIX + name);
+    if (name.startsWith(TAG_PREFIX)) {


Looks like we could drop all this prefixing stuff out of here and simply register blocks with the provided name. All the prefixing is done on the registerBlocks level.

nd0ut · 2024-07-16T14:40:22Z

types/jsx.d.ts

-    'lr-external-source': any;
-    'lr-cloud-image-editor-activity': any;
-    'lr-cloud-image-editor-block': CustomElement<
+    'uc-crop-frame': any;


We should leave both lr and uc prefixes here. Also it would be cool to have a typing test for it.

nd0ut · 2024-07-16T14:42:19Z

abstract/SolutionBlock.js

@@ -1,9 +1,9 @@
-import svgIconsSprite from '../blocks/themes/lr-basic/svg-sprite.js';
+import svgIconsSprite from '../blocks/themes/uc-basic/svg-sprite.js';


Dont forget to mention this path in the migration guides

nd0ut · 2024-07-22T12:57:32Z

Let's update LR to UC here:

https://github.com/uploadcare/blocks/blob/7071d954e9d5e87ca801233094a47a7afb4eacd3/abstract/connectBlocksFrom.js#L3
https://github.com/uploadcare/blocks/blob/7071d954e9d5e87ca801233094a47a7afb4eacd3/build.js#L30

nd0ut · 2024-07-25T10:45:16Z

README.md

@@ -71,59 +71,59 @@ We use [JSDoc type annotations](https://www.typescriptlang.org/docs/handbook/int

 ```html
 <script type="module">
-  import * as LR from 'https://cdn.jsdelivr.net/npm/@uploadcare/blocks@{{PACKAGE_VERSION}}/web/blocks.min.js';
+  import * as UC from 'https://cdn.jsdelivr.net/npm/@uploadcare/file-uploader@{{PACKAGE_VERSION}}/web/blocks.min.js';


Replace @{{PACKAGE_VERSION}} to @1

README.md

nd0ut · 2024-07-25T10:46:25Z

abstract/Block.js

@@ -14,7 +14,8 @@ import { l10nProcessor } from './l10nProcessor.js';
 import { sharedConfigKey } from './sharedConfigKey.js';
 import { A11y } from './a11y.js';

-const TAG_PREFIX = 'lr-';
+const TAG_PREFIX = 'uc-';
+const LEGACY_TAG_PREFIX = 'lr-';


I really not sure about this compatibility thing, let's discuss again today :)

Egor Didenko added 3 commits July 4, 2024 17:37

feat: replaceAll from lr to uc

2d0bd76

feat: Added the prefix uc to className via js and rename BtnUI

684c358

feat: Added Backward compatibility for build

341e5e5

egordidenko changed the title ~~Feat/rename blocks~~ feat: rename blocks from lr to uc Jul 15, 2024

nd0ut self-requested a review July 16, 2024 14:34

nd0ut requested changes Jul 16, 2024

View reviewed changes

Egor Didenko added 3 commits July 22, 2024 09:57

feat: rename import/export from LR to UC

306b257

Updated README.md

4d7f29c

feat(types): added JSX types for lr-

77fe52f

nd0ut reviewed Jul 25, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

nd0ut reviewed Jul 25, 2024

View reviewed changes

feat: support for lr only

154537d

egordidenko force-pushed the feat/rename-blocks branch from 0b1e4de to 154537d Compare July 25, 2024 12:39

feat: rename files

0fee0c8

nd0ut self-requested a review July 29, 2024 11:41

nd0ut approved these changes Jul 29, 2024

View reviewed changes

egordidenko marked this pull request as ready for review July 29, 2024 14:29

Merge branch 'main' into feat/rename-blocks

f9aed1d

egordidenko merged commit e28f2af into main Jul 29, 2024
1 check passed

egordidenko deleted the feat/rename-blocks branch July 29, 2024 14:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: rename blocks from lr to uc #698

feat: rename blocks from lr to uc #698

egordidenko commented Jul 15, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 15, 2024 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

nd0ut Jul 16, 2024

nd0ut Jul 16, 2024

nd0ut Jul 16, 2024

nd0ut commented Jul 22, 2024

nd0ut Jul 25, 2024

nd0ut Jul 25, 2024

		@@ -1,9 +1,9 @@
		import svgIconsSprite from '../blocks/themes/lr-basic/svg-sprite.js';
		import svgIconsSprite from '../blocks/themes/uc-basic/svg-sprite.js';

feat: rename blocks from lr to uc #698

feat: rename blocks from lr to uc #698

Conversation

egordidenko commented Jul 15, 2024 • edited by coderabbitai bot Loading

Description

Checklist

Summary by CodeRabbit

coderabbitai bot commented Jul 15, 2024 • edited Loading

Review failed

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

nd0ut Jul 16, 2024

Choose a reason for hiding this comment

nd0ut Jul 16, 2024

Choose a reason for hiding this comment

nd0ut Jul 16, 2024

Choose a reason for hiding this comment

nd0ut commented Jul 22, 2024

nd0ut Jul 25, 2024

Choose a reason for hiding this comment

nd0ut Jul 25, 2024

Choose a reason for hiding this comment

egordidenko commented Jul 15, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 15, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)