Skip to content

chore: add scripts/gen-semconv-ts.js to help generate semconv.ts files for unstable semconv consts #2669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trentm merged 6 commits into from
Feb 20, 2025
Merged

chore: add scripts/gen-semconv-ts.js to help generate semconv.ts files for unstable semconv consts #2669

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4dede11
chore: add scripts/gen-semconv-ts.js to help generate semconv.ts file…
trentm Jan 18, 2025
4f80e77
remove some cruft from this script
trentm Feb 11, 2025
6d64bb9
Merge branch 'main' into tm-gen-semconv-ts
trentm Feb 11, 2025
629f255
if no unstable semconv usages found, then don't write a src/semconv.t…
trentm Feb 11, 2025
c058095
update the script to use *typescript* sources to copy from, rather th…
trentm Feb 11, 2025
3484f6e
Merge branch 'main' into tm-gen-semconv-ts
trentm Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
remove some cruft from this script
  • Loading branch information
@trentm
trentm committed Feb 11, 2025
commit 4f80e77306775c68f5041aea3c2c18f24966e8b7
36 changes: 1 addition & 35 deletions scripts/gen-semconv-ts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,40 +58,6 @@ function getAllWorkspaceDirs() {
.map(path.dirname);
}

function lintSemconvDeps() {
const wsDirs = getAllWorkspaceDirs();

for (let wsDir of wsDirs) {
const pj = JSON.parse(
fs.readFileSync(path.join(wsDir, 'package.json'), 'utf8')
);
const depRange = pj?.dependencies?.[SEMCONV];
const devDepRange = pj?.devDependencies?.[SEMCONV];
if (!(depRange || devDepRange)) {
continue;
}

// Rule: The semconv dep should *not* be pinned. Expect `^X.Y.Z`.
const pinnedVerRe = /^\d+\.\d+\.\d+$/;
if (depRange && pinnedVerRe.exec(depRange)) {
problem(`${wsDir}/package.json: package ${pj.name} pins "${SEMCONV}" in dependencies, but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#why-not-pin-the-version)`);
} else if (devDepRange && pinnedVerRe.exec(devDepRange)) {
problem(`${wsDir}/package.json: package ${pj.name} pins "${SEMCONV}" in devDependencies, but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#why-not-pin-the-version)`);
}

// Rule: The incubating entry-point should not be used.
const srcFiles = globSync(path.join(wsDir, 'src', '**', '*.ts'));
const usesIncubatingRe = /import\s+\{?[^{;]*\s+from\s+'@opentelemetry\/semantic-conventions\/incubating'/s;
for (let srcFile of srcFiles) {
const srcText = fs.readFileSync(srcFile, 'utf8');
const match = usesIncubatingRe.exec(srcText);
if (match) {
problem(`${srcFile}: uses the 'incubating' entry-point from '@opentelemetry/semantic-conventions', but should not (see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv)`)
}
}
}
}

function genSemconvTs(wsDir) {
const semconvPath = require.resolve('@opentelemetry/semantic-conventions',
{paths: [path.join(wsDir, 'node_modules')]});
Expand Down Expand Up @@ -133,7 +99,7 @@ function genSemconvTs(wsDir) {
// Load the source from the semconv package from which we'll copy.
// We are cheating a bit in knowing the semconv package structure. We want
// "build/esnext/experimental_*.js" files. Use the "esnext" build because it
// is closed to the TypeScript we want.
// is closest to the TypeScript we want.
const semconvEsnextDir = path.resolve(
semconvPath,
'../../esnext', // .../build/src/index.js -> .../build/esnext
Expand Down