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

Move @typespec/compiler from dependencies to peerDependencies #3699

Merged
merged 2 commits into from
Jul 12, 2024
Merged

Move @typespec/compiler from dependencies to peerDependencies #3699

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9e0cf5
[@typespec/compiler] Move compiler dependencies to peer and dev depen…
sarangan12 Jun 28, 2024
7d82e2f
Executed chronus add
sarangan12 Jul 12, 2024
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
7 changes: 7 additions & 0 deletions .chronus/changes/Issue3632-2024-6-12-17-16-46.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
changeKind: feature
packages:
- "@typespec/compiler"
---

Moved compiler dependencies to peer and dev for scaffolded projects.
12 changes: 8 additions & 4 deletions packages/compiler/src/init/scaffold.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,21 +104,25 @@ async function writePackageJson(host: CompilerHost, config: ScaffoldingConfig) {
if (isFileSkipGeneration("package.json", config.template.files ?? [])) {
return;
}
const dependencies: Record<string, string> = {};
const peerDependencies: Record<string, string> = {};
const devDependencies: Record<string, string> = {};

if (!config.template.skipCompilerPackage) {
dependencies["@typespec/compiler"] = "latest";
peerDependencies["@typespec/compiler"] = "latest";
sarangan12 marked this conversation as resolved.
Show resolved Hide resolved
devDependencies["@typespec/compiler"] = "latest";
}

for (const library of config.libraries) {
dependencies[library.name] = await getLibraryVersion(library);
peerDependencies[library.name] = await getLibraryVersion(library);
devDependencies[library.name] = await getLibraryVersion(library);
}

const packageJson: NodePackage = {
name: config.name,
version: "0.1.0",
type: "module",
dependencies,
peerDependencies,
devDependencies,
private: true,
};

Expand Down
12 changes: 9 additions & 3 deletions packages/compiler/test/init/init-template.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ import { deepStrictEqual, strictEqual } from "assert";
import { beforeEach, describe, it } from "vitest";
import { InitTemplate } from "../../src/init/init-template.js";
import {
makeScaffoldingConfig,
ScaffoldingConfig,
makeScaffoldingConfig,
scaffoldNewProject,
} from "../../src/init/scaffold.js";
import { createTestHost, resolveVirtualPath, TestHost } from "../../src/testing/index.js";
import { TestHost, createTestHost, resolveVirtualPath } from "../../src/testing/index.js";

describe("compiler: init: templates", () => {
let testHost: TestHost;
Expand Down Expand Up @@ -44,7 +44,13 @@ describe("compiler: init: templates", () => {
libraries: [{ name: "foo", version: "~1.2.3" }, { name: "bar" }],
});

deepStrictEqual(JSON.parse(getOutputFile("package.json")!).dependencies, {
deepStrictEqual(JSON.parse(getOutputFile("package.json")!).peerDependencies, {
"@typespec/compiler": "latest",
foo: "~1.2.3",
bar: "latest",
});

deepStrictEqual(JSON.parse(getOutputFile("package.json")!).devDependencies, {
"@typespec/compiler": "latest",
foo: "~1.2.3",
bar: "latest",
Expand Down
Loading