chore: merge cds-core tools to clr-angular (WIP) #1515

Jinnie · 2024-08-09T10:46:49Z

PR Checklist

Please check if your PR fulfills the following requirements:

Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)
If applicable, have a visual design approval

PR Type

What kind of change does this PR introduce?

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

Yes
No

Other information

github-actions · 2024-08-09T10:47:04Z

👋 @Jinnie,

🙏 The Clarity team thanks you for opening a pull request
🎉 The build for this PR has succeeded
🔍 The PR is now ready for review
🍿 In the meantime, view a preview of this PR
🖐 You can always follow up here. If you're a VMware employee, you can also reach us on our internal Clarity Support space

Thank you,

🤖 Clarity Release Bot

projects/angular/src/data/datagrid/datagrid-filter.spec.ts

package.json

projects/angular/src/layout/nav/nav-level.ts

Jinnie · 2024-08-13T08:26:35Z

projects/core/README.md

+
+## Quick Start Install
+
+1.  First, install the Clarity Core package from npm.


The info in this file is irrelevant now. It should either be updated, or the file deleted.

Jinnie

The content of /projects/core/build should be reviewed. Some storybook and website related tools exist, that are not relevant to the new location.

netlify · 2024-08-14T13:38:36Z

✅ Deploy Preview for clarity-date-range ready!

Name	Link
🔨 Latest commit	`8512188`
🔍 Latest deploy log	https://app.netlify.com/sites/clarity-date-range/deploys/66bcb348b8526500087923c3
😎 Deploy Preview	https://deploy-preview-1515--clarity-date-range.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

kevinbuhmann · 2024-08-14T16:12:30Z

package.json

@@ -66,21 +70,32 @@
    "@angular/platform-browser": "15.2.2",
    "@angular/platform-browser-dynamic": "15.2.2",
    "@angular/router": "15.2.2",
-    "@cds/core": "6.9.2",
+    "@cds/core": "file:dist/@cds/core",


I don't think this should be in package.json. I think it would be better to use path aliases in tsconfig.json so that you don't have to have core built before staring ng-clarity.

Another problem with this is that the cds-icon imports work in this project, but the icon component is not included in a published package. I think this needs to be restructured so that there is not a ./dist/@cds/core folder. It's not actually a dist folder anyway because it is not published. Instead, I think the styles/tokens should be in @clr/ui and the icon component should be in @clr/angular. Otherwise, there is no way for consumers of the published packages to use the things that used to be in @cds/core.

It's still one of the WIP parts. And your feedback is very valuable.
The idea is to either have a separate package (but not named @cds/core, maybe @clr/core or something else), or, as you say, move tokens to @clr/ui and the rest to @clr/angular (or a smaller core package).
The problem with moving them to the existing packages is that many of the consumable artefacts should still be built before we're able to import and use them.
As a next step we can explore the merging option, and if unsuccessful, fall back to a @clr/core or similar package.

kevinbuhmann · 2024-08-14T16:13:55Z

projects/angular/src/layout/nav/nav-level.ts

-  cdsCloseButton.setAttribute('aria-label', ariaLabel);
-  cdsCloseButton.setAttribute('aria-hidden', 'true');
-  cdsCloseButton.setAttribute('type', 'button');
+const createCloseButton = (document: Document, ariaLabel: string) => {


I think this change should be extracted to a separate PR that just removes dependency on cds-internal-close-button.

Yes, we can do it before the rest of this PR lands.

Done, with PR #1539

kevinbuhmann · 2024-08-14T16:14:30Z

projects/angular/src/utils/_mixins.scss

+  & {
+    @if (map.has-key($map, $key)) {


Why is this change needed?

At some point I was using a newer SASS version and it started reporting issues with the order of mixins vs declarations.
But once we need to do this, we'd better do it separately from this PR and when the change is needed.
I'll revert this.

Done. Also remove the same change from _buttons...

kevinbuhmann · 2024-08-14T16:23:34Z

projects/core/build/build.tokens.ts

+buildAndroidXMLTokens('./dist/@cds/core/tokens/tokens.android.xml');
+buildIOSSwiftTokens('./dist/@cds/core/tokens/tokens.ios.swift');


I think these should be removed. The ./dist/@cds/core folder is not published as a package, so this is dead code.

Good catch, I removed some, but these I've missed.

kevinbuhmann · 2024-08-14T16:25:41Z

package.json

@@ -66,21 +70,32 @@
    "@angular/platform-browser": "15.2.2",
    "@angular/platform-browser-dynamic": "15.2.2",
    "@angular/router": "15.2.2",
-    "@cds/core": "6.9.2",
+    "@cds/core": "file:dist/@cds/core",
+    "@commitlint/cz-commitlint": "16.2.3",


This should be removed.

kevinbuhmann · 2024-08-14T16:26:30Z

package.json

@@ -103,15 +118,28 @@
    "karma-mocha-reporter": "2.2.5",
    "karma-parallel": "0.3.1",
    "lint-staged": "12.3.7",
+    "lit": "^2.1.3",


This should be an exact version.

kevinbuhmann · 2024-08-14T16:26:46Z

package.json

    "ng-packagr": "15.0.1",
    "node-static": "0.7.11",
    "npm-run-all": "4.1.5",
    "patch-package": "6.4.7",
    "playwright": "1.43.0",
    "postcss-cli": "8.3.1",
    "prettier": "2.6.2",
+    "purgecss": "^4.1.3",


This should be an exact version.

kevinbuhmann · 2024-08-14T16:30:59Z

projects/demo/src/styles.scss

+@import '../../../dist/@cds/core/styles/module.reset.min.css';
+@import '../../../dist/@cds/core/styles/module.tokens.min.css';
+@import '../../../dist/@cds/core/styles/module.layout.min.css';
+@import '../../../dist/@cds/core/styles/module.typography.min.css';
+@import '../../../dist/@cds/core/styles/theme.dark.min.css';


How are consumer supposed to import these files? I think we need to build these files into the @clr/ui directory so that they are included in a published package.

This will be handled once we make a choice and provide solution, as discussed in my reply to your first comment above.

For now, changing the import to be through @cds/core/styles/....., so we don't rely on direct relative paths and dist.

github-actions · 2024-09-03T13:08:12Z

This PR introduces visual changes: 57a4d47
If these changes are intended and correct, please cherry-pick the above commit to this PR.

git checkout jinnie/cds-core-to-clr
git fetch https://github.com/vmware-clarity/ng-clarity.git 57a4d47d365107e79dc9b4664c25ae9fe5d73d83
git cherry-pick 57a4d47d365107e79dc9b4664c25ae9fe5d73d83
git push

github-actions · 2024-09-04T10:38:32Z

This PR introduces visual changes: 8cb1534
If these changes are intended and correct, please cherry-pick the above commit to this PR.

git checkout jinnie/cds-core-to-clr
git fetch https://github.com/vmware-clarity/ng-clarity.git 8cb1534c782ef0b7b015c761818d31dda573bcfc
git cherry-pick 8cb1534c782ef0b7b015c761818d31dda573bcfc
git push

vmwclabot added the cla-not-required label Aug 9, 2024

kevinbuhmann assigned Jinnie Aug 12, 2024

Jinnie commented Aug 12, 2024

View reviewed changes

projects/angular/src/data/datagrid/datagrid-filter.spec.ts Outdated Show resolved Hide resolved

Jinnie commented Aug 13, 2024

View reviewed changes

package.json Outdated Show resolved Hide resolved

Jinnie commented Aug 13, 2024

View reviewed changes

projects/angular/src/layout/nav/nav-level.ts Outdated Show resolved Hide resolved

Jinnie commented Aug 13, 2024

View reviewed changes

kevinbuhmann reviewed Aug 14, 2024

View reviewed changes

Jinnie force-pushed the jinnie/cds-core-to-clr branch 2 times, most recently from 415ea42 to 45b8ce1 Compare August 15, 2024 08:15

Jinnie force-pushed the jinnie/cds-core-to-clr branch 2 times, most recently from d6c05d5 to bc46b1c Compare September 3, 2024 10:50

Jinnie added 8 commits September 4, 2024 13:22

chore: merge cds-core tools to clr-angular

f938063

fix: restore custom-element-manifest analyzer function

b0b2696

fix: linting fixes

ced3492

fix: use fixed versions for typescript and related tools

66e5e26

fix: use fixed versions for rollup and tools

2dd863f

fix: check rollup and tsc versions during runtime

3b940a7

fix: update rollup version

9901452

fix: remove test dependency on cds-button

79a921f

Jinnie added 7 commits September 4, 2024 13:22

fix: return husky

7263898

fix: post rebase package-lock update

45bbad3

fix: add review feedback; fix demo app

fc75f64

fix: fix module.tokens exports

e6f355c

fix: update packate-lock after rebase

61fc456

fix: build core for visual tests

310dd37

fix: move cds/core to clr/core namespace

4b800dd

Jinnie force-pushed the jinnie/cds-core-to-clr branch from b34b4aa to 4b800dd Compare September 4, 2024 10:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: merge cds-core tools to clr-angular (WIP) #1515

chore: merge cds-core tools to clr-angular (WIP) #1515

Jinnie commented Aug 9, 2024

github-actions bot commented Aug 9, 2024 •

edited

Loading

Jinnie Aug 13, 2024

Jinnie left a comment

netlify bot commented Aug 14, 2024 •

edited

Loading

kevinbuhmann Aug 14, 2024

kevinbuhmann Aug 14, 2024 •

edited

Loading

Jinnie Aug 15, 2024

kevinbuhmann Aug 14, 2024

Jinnie Aug 15, 2024

Jinnie Sep 3, 2024

kevinbuhmann Aug 14, 2024

Jinnie Aug 15, 2024

Jinnie Aug 15, 2024

kevinbuhmann Aug 14, 2024

Jinnie Aug 15, 2024

Jinnie Aug 15, 2024

kevinbuhmann Aug 14, 2024

kevinbuhmann Aug 14, 2024

Jinnie Aug 15, 2024

kevinbuhmann Aug 14, 2024

Jinnie Aug 15, 2024

kevinbuhmann Aug 14, 2024

Jinnie Aug 15, 2024

Jinnie Aug 15, 2024

github-actions bot commented Sep 3, 2024

github-actions bot commented Sep 4, 2024


		## Quick Start Install

		1. First, install the Clarity Core package from npm.

		buildAndroidXMLTokens('./dist/@cds/core/tokens/tokens.android.xml');
		buildIOSSwiftTokens('./dist/@cds/core/tokens/tokens.ios.swift');

chore: merge cds-core tools to clr-angular (WIP) #1515

Are you sure you want to change the base?

chore: merge cds-core tools to clr-angular (WIP) #1515

Conversation

Jinnie commented Aug 9, 2024

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

github-actions bot commented Aug 9, 2024 • edited Loading

Choose a reason for hiding this comment

Jinnie left a comment

Choose a reason for hiding this comment

netlify bot commented Aug 14, 2024 • edited Loading

✅ Deploy Preview for clarity-date-range ready!

Choose a reason for hiding this comment

kevinbuhmann Aug 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 3, 2024

github-actions bot commented Sep 4, 2024

github-actions bot commented Aug 9, 2024 •

edited

Loading

netlify bot commented Aug 14, 2024 •

edited

Loading

kevinbuhmann Aug 14, 2024 •

edited

Loading