Skip to content
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

Jump to bottom

[dev-tool] Allow relative-path imports in sample files. #14665

Merged
merged 1 commit into from
Apr 2, 2021
Merged

[dev-tool] Allow relative-path imports in sample files. #14665

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 25 additions & 3 deletions common/tools/dev-tool/src/commands/samples/publish.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,28 @@ function createPackageJson(info: SampleGenerationInfo, outputKind: OutputKind):
};
}

/**
* Determines whether a module specifier is a package dependency.
*
* A dependency is a module specifier that does not refer to a node builtin and
* is not a relative path.
*
* Absolute path imports are not supported in samples (because the package base
* is not fixed relative to the source file).
*
* @param moduleSpecifier - the string given to `import` or `require`
* @returns - true if `moduleSpecifier` should be considered a reference to a
* node module dependency
*/
function isDependency(moduleSpecifier: string): boolean {
if (nodeBuiltins.includes(moduleSpecifier)) return false;

// This seems like a reasonable test for "is a relative path" as long as
// absolute path imports are forbidden.
const isRelativePath = /^\.\.?\//.test(moduleSpecifier);
return !isRelativePath;
Comment on lines +119 to +124
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT:

Suggested change
if (nodeBuiltins.includes(moduleSpecifier)) return false;
// This seems like a reasonable test for "is a relative path" as long as
// absolute path imports are forbidden.
const isRelativePath = /^\.\.?\//.test(moduleSpecifier);
return !isRelativePath;
return !(nodeBuiltins.includes(moduleSpecifier) ||
// This seems like a reasonable test for "is a relative path" as long as
// absolute path imports are forbidden.
/^\.\.?\//.test(moduleSpecifier));

Not sure about formatting though :)

}

async function processSources(
projectInfo: ProjectInfo,
sources: string[],
Expand Down Expand Up @@ -217,7 +239,7 @@ async function processSources(
}
}),
summary: summary ?? fail(`${relativeSourcePath} does not include an @summary tag.`),
importedModules: importedModules.filter((name) => !nodeBuiltins.includes(name)),
importedModules: importedModules.filter(isDependency),
usedEnvironmentVariables,
azSdkTags
};
Expand Down Expand Up @@ -328,10 +350,10 @@ async function makeSampleGenerationInfo(
packageJson.dependencies[dependency];
if (dependencyVersion === undefined) {
log.error(
`Dependency "${dependency}", imported by ${source.filePath}, has an unknown version.`
`Dependency "${dependency}", imported by ${source.filePath}, has an unknown version. (Are you missing "./" for a relative path?)`
);
log.error(
"Specify a version for it by including it in the package's `devDependencies`."
`Specify a version for "${dependency}" by including it in the package's "devDependencies".`
);
}

Expand Down
2 changes: 2 additions & 0 deletions common/tools/dev-tool/src/util/sampleGenerationInfo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ export const DEFAULT_TYPESCRIPT_CONFIG = {
compilerOptions: {
target: "ES2018",
module: "commonjs",

moduleResolution: "node",
resolveJsonModule: true,

esModuleInterop: true,
allowSyntheticDefaultImports: true,
Expand Down