Add project files
This commit is contained in:
202
packages/@dyad-sh/nextjs-webpack-component-tagger/LICENSE
Normal file
202
packages/@dyad-sh/nextjs-webpack-component-tagger/LICENSE
Normal file
@@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2025 Dyad Tech, Inc.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
65
packages/@dyad-sh/nextjs-webpack-component-tagger/README.md
Normal file
65
packages/@dyad-sh/nextjs-webpack-component-tagger/README.md
Normal file
@@ -0,0 +1,65 @@
|
||||
# @dyad-sh/nextjs-webpack-component-tagger
|
||||
|
||||
A webpack loader for Next.js that automatically adds `data-dyad-id` and `data-dyad-name` attributes to your React components. This is useful for identifying components in the DOM, for example for testing or analytics.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @dyad-sh/nextjs-webpack-component-tagger
|
||||
# or
|
||||
yarn add @dyad-sh/nextjs-webpack-component-tagger
|
||||
# or
|
||||
pnpm add @dyad-sh/nextjs-webpack-component-tagger
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add the loader to your `next.config.js` file:
|
||||
|
||||
```ts
|
||||
import type { NextConfig } from "next";
|
||||
|
||||
const nextConfig: NextConfig = {
|
||||
webpack: (config) => {
|
||||
if (process.env.NODE_ENV === "development") {
|
||||
config.module.rules.push({
|
||||
test: /\.(jsx|tsx)$/,
|
||||
exclude: /node_modules/,
|
||||
enforce: "pre",
|
||||
use: "@dyad-sh/nextjs-webpack-component-tagger",
|
||||
});
|
||||
}
|
||||
return config;
|
||||
},
|
||||
};
|
||||
|
||||
export default nextConfig;
|
||||
```
|
||||
|
||||
The loader will automatically add `data-dyad-id` and `data-dyad-name` to all your React components.
|
||||
|
||||
The `data-dyad-id` will be a unique identifier for each component instance, in the format `path/to/file.tsx:line:column`.
|
||||
|
||||
The `data-dyad-name` will be the name of the component.
|
||||
|
||||
## Testing & Publishing
|
||||
|
||||
Bump it to an alpha version and test in Dyad app, eg. `"version": "0.0.1-alpha.0",`
|
||||
|
||||
Then publish it:
|
||||
|
||||
```sh
|
||||
cd packages/@dyad-sh/nextjs-webpack-component-tagger/ && npm run prepublishOnly && npm publish
|
||||
```
|
||||
|
||||
Update the package version in the nextjs-template repo in your personal fork.
|
||||
|
||||
Update the `src/shared/templates.ts` to use your fork of the next.js template, e.g.
|
||||
|
||||
```
|
||||
githubUrl: "https://github.com/wwwillchen/nextjs-template",
|
||||
```
|
||||
|
||||
Run the E2E tests and make sure it passes.
|
||||
|
||||
Then, bump to a normal version, e.g. "0.1.0" and then re-publish. We'll try to match the main Dyad app version where possible.
|
||||
3858
packages/@dyad-sh/nextjs-webpack-component-tagger/package-lock.json
generated
Normal file
3858
packages/@dyad-sh/nextjs-webpack-component-tagger/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,45 @@
|
||||
{
|
||||
"name": "@dyad-sh/nextjs-webpack-component-tagger",
|
||||
"version": "0.8.0",
|
||||
"description": "A webpack loader that automatically adds data attributes to your React components in Next.js.",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.mjs",
|
||||
"types": "dist/index.d.ts",
|
||||
"type": "module",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsup src/index.ts --format cjs,esm --dts",
|
||||
"dev": "npm run build -- --watch",
|
||||
"lint": "eslint . --max-warnings 0",
|
||||
"prepublishOnly": "npm run build"
|
||||
},
|
||||
"keywords": [
|
||||
"webpack",
|
||||
"webpack-loader",
|
||||
"nextjs",
|
||||
"react",
|
||||
"dyad"
|
||||
],
|
||||
"author": "Dyad",
|
||||
"license": "Apache-2.0",
|
||||
"peerDependencies": {
|
||||
"webpack": "^5.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@babel/parser": "^7.23.0",
|
||||
"estree-walker": "^2.0.2",
|
||||
"magic-string": "^0.30.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.8.9",
|
||||
"@types/webpack": "^5.28.5",
|
||||
"eslint": "^8.52.0",
|
||||
"tsup": "^8.0.2",
|
||||
"typescript": "^5.2.2"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
}
|
||||
}
|
||||
109
packages/@dyad-sh/nextjs-webpack-component-tagger/src/index.ts
Normal file
109
packages/@dyad-sh/nextjs-webpack-component-tagger/src/index.ts
Normal file
@@ -0,0 +1,109 @@
|
||||
import { parse } from "@babel/parser";
|
||||
import MagicString from "magic-string";
|
||||
import path from "node:path";
|
||||
import { walk } from "estree-walker";
|
||||
|
||||
const VALID_EXTENSIONS = new Set([".jsx", ".tsx"]);
|
||||
|
||||
/**
|
||||
* A webpack loader that adds `data-dyad-*` attributes to JSX elements.
|
||||
*/
|
||||
export default function dyadTaggerLoader(this: any, code: string) {
|
||||
// Signal that this is an async loader
|
||||
const callback = this.async();
|
||||
|
||||
const transform = async () => {
|
||||
try {
|
||||
// Skip non-JSX files and node_modules
|
||||
if (
|
||||
!VALID_EXTENSIONS.has(path.extname(this.resourcePath)) ||
|
||||
this.resourcePath.includes("node_modules")
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Parse the AST
|
||||
const ast = parse(code, {
|
||||
sourceType: "module",
|
||||
plugins: ["jsx", "typescript"],
|
||||
sourceFilename: this.resourcePath,
|
||||
});
|
||||
|
||||
const ms = new MagicString(code);
|
||||
const fileRelative = path.relative(this.rootContext, this.resourcePath);
|
||||
let transformCount = 0;
|
||||
|
||||
// Walk the AST and transform JSX elements
|
||||
walk(ast as any, {
|
||||
enter: (node: any) => {
|
||||
try {
|
||||
if (node.type !== "JSXOpeningElement") return;
|
||||
|
||||
// Extract the tag/component name
|
||||
if (node.name?.type !== "JSXIdentifier") return;
|
||||
const tagName = node.name.name;
|
||||
if (!tagName) return;
|
||||
|
||||
// Skip if already tagged
|
||||
const alreadyTagged = node.attributes?.some(
|
||||
(attr: any) =>
|
||||
attr.type === "JSXAttribute" &&
|
||||
attr.name?.name === "data-dyad-id",
|
||||
);
|
||||
if (alreadyTagged) return;
|
||||
|
||||
// Build the dyad ID
|
||||
const loc = node.loc?.start;
|
||||
if (!loc) return;
|
||||
const dyadId = `${fileRelative}:${loc.line}:${loc.column}`;
|
||||
|
||||
// Inject the attributes
|
||||
if (node.name.end != null) {
|
||||
ms.appendLeft(
|
||||
node.name.end,
|
||||
` data-dyad-id="${dyadId}" data-dyad-name="${tagName}"`,
|
||||
);
|
||||
transformCount++;
|
||||
}
|
||||
} catch (error) {
|
||||
console.warn(
|
||||
`[dyad-tagger] Warning: Failed to process JSX node in ${this.resourcePath}:`,
|
||||
error,
|
||||
);
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
// Return null if no changes were made
|
||||
if (transformCount === 0) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const transformedCode = ms.toString();
|
||||
return {
|
||||
code: transformedCode,
|
||||
map: ms.generateMap({ hires: true }),
|
||||
};
|
||||
} catch (error) {
|
||||
console.warn(
|
||||
`[dyad-tagger] Warning: Failed to transform ${this.resourcePath}:`,
|
||||
error,
|
||||
);
|
||||
return null;
|
||||
}
|
||||
};
|
||||
|
||||
transform()
|
||||
.then((result) => {
|
||||
if (result) {
|
||||
callback(null, result.code, result.map);
|
||||
} else {
|
||||
callback(null, code);
|
||||
}
|
||||
})
|
||||
.catch((err) => {
|
||||
console.error(`[dyad-tagger] ERROR in ${this.resourcePath}:`, err);
|
||||
// Return original code instead of throwing
|
||||
callback(null, code);
|
||||
});
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"module": "ESNext",
|
||||
"lib": ["ES2020"],
|
||||
"moduleResolution": "node",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"outDir": "dist",
|
||||
"declaration": true
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
4
packages/@dyad-sh/react-vite-component-tagger/.npmignore
Normal file
4
packages/@dyad-sh/react-vite-component-tagger/.npmignore
Normal file
@@ -0,0 +1,4 @@
|
||||
node_modules
|
||||
src
|
||||
tsconfig.json
|
||||
.DS_Store
|
||||
202
packages/@dyad-sh/react-vite-component-tagger/LICENSE
Normal file
202
packages/@dyad-sh/react-vite-component-tagger/LICENSE
Normal file
@@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2025 Dyad Tech, Inc.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
54
packages/@dyad-sh/react-vite-component-tagger/README.md
Normal file
54
packages/@dyad-sh/react-vite-component-tagger/README.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# @dyad-sh/react-vite-component-tagger
|
||||
|
||||
A Vite plugin that automatically adds `data-dyad-id` and `data-dyad-name` attributes to your React components. This is useful for identifying components in the DOM, for example for testing or analytics.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @dyad-sh/react-vite-component-tagger
|
||||
# or
|
||||
yarn add @dyad-sh/react-vite-component-tagger
|
||||
# or
|
||||
pnpm add @dyad-sh/react-vite-component-tagger
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Add the plugin to your `vite.config.ts` file:
|
||||
|
||||
```ts
|
||||
import { defineConfig } from "vite";
|
||||
import react from "@vitejs/plugin-react";
|
||||
import dyadTagger from "@dyad-sh/react-vite-component-tagger";
|
||||
|
||||
// https://vitejs.dev/config/
|
||||
export default defineConfig({
|
||||
plugins: [react(), dyadTagger()],
|
||||
});
|
||||
```
|
||||
|
||||
The plugin will automatically add `data-dyad-id` and `data-dyad-name` to all your React components.
|
||||
|
||||
The `data-dyad-id` will be a unique identifier for each component instance, in the format `path/to/file.tsx:line:column`.
|
||||
|
||||
The `data-dyad-name` will be the name of the component.
|
||||
|
||||
## Testing & Publishing
|
||||
|
||||
Bump it to an alpha version and test in Dyad app, eg. `"version": "0.0.1-alpha.0",`
|
||||
|
||||
Then publish it:
|
||||
|
||||
```sh
|
||||
cd packages/@dyad-sh/react-vite-component-tagger/ && npm run prepublishOnly && npm publish
|
||||
```
|
||||
|
||||
Update the scaffold like this:
|
||||
|
||||
```sh
|
||||
cd scaffold && pnpm remove @dyad-sh/react-vite-component-tagger && pnpm add -D @dyad-sh/react-vite-component-tagger
|
||||
```
|
||||
|
||||
Run the E2E tests and make sure it passes.
|
||||
|
||||
Then, bump to a normal version, e.g. "0.1.0" and then re-publish. We'll try to match the main Dyad app version where possible.
|
||||
3646
packages/@dyad-sh/react-vite-component-tagger/package-lock.json
generated
Normal file
3646
packages/@dyad-sh/react-vite-component-tagger/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
44
packages/@dyad-sh/react-vite-component-tagger/package.json
Normal file
44
packages/@dyad-sh/react-vite-component-tagger/package.json
Normal file
@@ -0,0 +1,44 @@
|
||||
{
|
||||
"name": "@dyad-sh/react-vite-component-tagger",
|
||||
"version": "0.8.0",
|
||||
"description": "A Vite plugin that automatically adds data attributes to your React components.",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.mjs",
|
||||
"types": "dist/index.d.ts",
|
||||
"type": "module",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsup src/index.ts --format cjs,esm --dts",
|
||||
"dev": "npm run build -- --watch",
|
||||
"lint": "eslint . --max-warnings 0",
|
||||
"prepublishOnly": "npm run build"
|
||||
},
|
||||
"keywords": [
|
||||
"vite",
|
||||
"vite-plugin",
|
||||
"react",
|
||||
"dyad"
|
||||
],
|
||||
"author": "Dyad",
|
||||
"license": "Apache-2.0",
|
||||
"peerDependencies": {
|
||||
"vite": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@babel/parser": "^7.23.0",
|
||||
"estree-walker": "^2.0.2",
|
||||
"magic-string": "^0.30.5"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^20.8.9",
|
||||
"eslint": "^8.52.0",
|
||||
"tsup": "^8.0.2",
|
||||
"typescript": "^5.2.2",
|
||||
"vite": "^5.0.0"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
}
|
||||
}
|
||||
90
packages/@dyad-sh/react-vite-component-tagger/src/index.ts
Normal file
90
packages/@dyad-sh/react-vite-component-tagger/src/index.ts
Normal file
@@ -0,0 +1,90 @@
|
||||
import { parse } from "@babel/parser";
|
||||
import MagicString from "magic-string";
|
||||
import path from "node:path";
|
||||
import { walk } from "estree-walker";
|
||||
import type { Plugin } from "vite";
|
||||
|
||||
const VALID_EXTENSIONS = new Set([".jsx", ".tsx"]);
|
||||
|
||||
/**
|
||||
* Returns a Vite / esbuild plug-in.
|
||||
*/
|
||||
export default function dyadTagger(): Plugin {
|
||||
return {
|
||||
name: "vite-plugin-dyad-tagger",
|
||||
apply: "serve",
|
||||
enforce: "pre",
|
||||
|
||||
async transform(code: string, id: string) {
|
||||
try {
|
||||
// Ignore non-jsx files and files inside node_modules
|
||||
if (
|
||||
!VALID_EXTENSIONS.has(path.extname(id)) ||
|
||||
id.includes("node_modules")
|
||||
)
|
||||
return null;
|
||||
|
||||
const ast = parse(code, {
|
||||
sourceType: "module",
|
||||
plugins: ["jsx", "typescript"],
|
||||
});
|
||||
|
||||
const ms = new MagicString(code);
|
||||
const fileRelative = path.relative(process.cwd(), id);
|
||||
|
||||
walk(ast as any, {
|
||||
enter(node: any) {
|
||||
try {
|
||||
if (node.type !== "JSXOpeningElement") return;
|
||||
|
||||
// ── 1. Extract the tag / component name ──────────────────────────────
|
||||
if (node.name?.type !== "JSXIdentifier") return;
|
||||
const tagName = node.name.name as string;
|
||||
if (!tagName) return;
|
||||
|
||||
// ── 2. Check whether the tag already has data-dyad-id ───────────────
|
||||
const alreadyTagged = node.attributes?.some(
|
||||
(attr: any) =>
|
||||
attr.type === "JSXAttribute" &&
|
||||
attr.name?.name === "data-dyad-id",
|
||||
);
|
||||
if (alreadyTagged) return;
|
||||
|
||||
// ── 3. Build the id "relative/file.jsx:line:column" ─────────────────
|
||||
const loc = node.loc?.start;
|
||||
if (!loc) return;
|
||||
const dyadId = `${fileRelative}:${loc.line}:${loc.column}`;
|
||||
|
||||
// ── 4. Inject the attributes just after the tag name ────────────────
|
||||
if (node.name.end != null) {
|
||||
ms.appendLeft(
|
||||
node.name.end,
|
||||
` data-dyad-id="${dyadId}" data-dyad-name="${tagName}"`,
|
||||
);
|
||||
}
|
||||
} catch (error) {
|
||||
console.warn(
|
||||
`[dyad-tagger] Warning: Failed to process JSX node in ${id}:`,
|
||||
error,
|
||||
);
|
||||
}
|
||||
},
|
||||
});
|
||||
|
||||
// If nothing changed bail out.
|
||||
if (ms.toString() === code) return null;
|
||||
|
||||
return {
|
||||
code: ms.toString(),
|
||||
map: ms.generateMap({ hires: true }),
|
||||
};
|
||||
} catch (error) {
|
||||
console.warn(
|
||||
`[dyad-tagger] Warning: Failed to transform ${id}:`,
|
||||
error,
|
||||
);
|
||||
return null;
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
16
packages/@dyad-sh/react-vite-component-tagger/tsconfig.json
Normal file
16
packages/@dyad-sh/react-vite-component-tagger/tsconfig.json
Normal file
@@ -0,0 +1,16 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"module": "ESNext",
|
||||
"lib": ["ES2020"],
|
||||
"moduleResolution": "node",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"outDir": "dist",
|
||||
"declaration": true
|
||||
},
|
||||
"include": ["src"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
Reference in New Issue
Block a user