.projenrc.js

const {
  cdk,
  javascript,
  JsonFile,
  ProjectTree,
  TextFile,
  ReleasableCommits,
  DependencyType,
} = require("./lib");
const { PROJEN_MARKER } = require("./lib/common");

const project = new cdk.JsiiProject({
  name: "projen",
  description: "CDK for software projects",
  repository: "https://github.com/projen/projen.git",

  authorName: "Amazon Web Services",
  authorUrl: "https://aws.amazon.com",
  authorOrganization: true,

  stability: "experimental",
  keywords: [
    "scaffolding",
    "cicd",
    "project",
    "management",
    "generator",
    "cdk",
  ],

  githubOptions: {
    pullRequestLintOptions: {
      contributorStatement:
        "By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.",
      contributorStatementOptions: {
        exemptUsers: ["cdklabs-automation", "dependabot[bot]"],
      },
    },
  },

  jsiiVersion: "5.1.x",
  typescriptVersion: "5.1.x",

  deps: ["constructs@^10.0.0"],

  bundledDeps: [
    "conventional-changelog-config-spec",
    "yaml@^2.2.2",
    "yargs",
    "case",
    "glob@^8",
    "semver",
    "chalk",
    "@iarna/toml",
    "xmlbuilder2",
    "ini",
    "shx",
    "fast-json-patch",
    "comment-json@4.2.2",
  ],

  devDeps: [
    "@types/conventional-changelog-config-spec",
    "@types/yargs",
    "@types/glob",
    "@types/semver",
    "@types/ini",
    "markmac",
    "esbuild",
    "all-contributors-cli",
  ],

  peerDeps: ["constructs@^10.0.0"],

  depsUpgrade: false, // configured below

  projenDevDependency: false, // because I am projen
  releaseToNpm: true,
  minNodeVersion: "16.0.0", // Do not change this before a version has been EOL for a while
  workflowNodeVersion: "18.14.0",

  codeCov: true,
  prettier: true,
  defaultReleaseBranch: "main",
  gitpod: true,
  devContainer: true,
  // since this is projen, we need to always compile before we run
  projenCommand: "/bin/bash ./projen.bash",

  // cli tests need projen to be compiled
  compileBeforeTest: true,

  // Disable interop since it's disabled available in jsii
  tsconfigDev: {
    compilerOptions: {
      esModuleInterop: false,
    },
  },

  jestOptions: {
    // makes it very hard to iterate with jest --watch
    coverageText: false,
    jestConfig: {
      // By default jest will try to use all CPU cores on the running machine.
      // But some of our integration tests spawn child processes - so by
      // creating one jest worker per test, some of the child processes will get
      // starved of CPU time and sometimes hang or timeout. This should
      // help mitigate that.
      maxWorkers: "50%",
    },
  },

  // To reduce the release frequency we only release features and fixes
  // This is important because PyPI has limits on the total storage amount used, and extensions need to be manually requested
  releasableCommits: ReleasableCommits.featuresAndFixes(),

  publishToMaven: {
    javaPackage: "io.github.cdklabs.projen",
    mavenGroupId: "io.github.cdklabs",
    mavenArtifactId: "projen",
    mavenEndpoint: "https://s01.oss.sonatype.org",
  },
  publishToPypi: {
    distName: "projen",
    module: "projen",
  },
  publishToGo: {
    moduleName: "github.com/projen/projen-go",
  },

  releaseFailureIssue: true,

  autoApproveUpgrades: true,
  autoApproveOptions: { allowedUsernames: ["cdklabs-automation"] },

  docgenFilePath: "docs/api/API.md",
});

// Upgrade Dependencies in two parts:
// a) Upgrade bundled dependencies as a releasable fix
// b) Upgrade devDependencies as a chore
new javascript.UpgradeDependencies(project, {
  taskName: "upgrade-bundled",
  types: [DependencyType.BUNDLED],
  semanticCommit: "fix",
  pullRequestTitle: "upgrade bundled dependencies",
  workflowOptions: {
    labels: ["auto-approve"],
    // Run projen's daily upgrade (and release) acyclic to the schedule that projects are on so they get updates faster
    schedule: javascript.UpgradeDependenciesSchedule.expressions([
      "0 12 * * *",
    ]),
  },
});
new javascript.UpgradeDependencies(project, {
  taskName: "upgrade",
  exclude: [
    // exclude the bundled deps
    ...project.deps.all
      .filter((d) => d.type === DependencyType.BUNDLED)
      .map((d) => d.name),
    // constructs version constraint should not be changed
    "constructs",
    // markmac depends on projen, we are excluding it here to avoid a circular update loop
    "markmac",
  ],
  workflowOptions: {
    labels: ["auto-approve"],
  },
});

// this script is what we use as the projen command in this project
// it will compile the project if needed and then run the cli.
new TextFile(project, "projen.bash", {
  lines: [
    "#!/bin/bash",
    `# ${PROJEN_MARKER}`,
    "set -euo pipefail",
    "if [ ! -f lib/cli/index.js ]; then",
    '  echo "bootstrapping..."',
    "  npx jsii --silence-warnings=reserved-word --no-fix-peer-dependencies",
    "fi",
    "exec bin/projen $@",
  ],
  executable: true,
});
project.npmignore.exclude("/projen.bash");

project.addExcludeFromCleanup("test/**"); // because snapshots include the projen marker...
project.gitignore.include("templates/**");
project.gitignore.exclude("/.idea");
project.gitignore.include("test/inventory/**");

// expand markdown macros in readme
const macros = project.addTask("readme-macros");
macros.exec("mv README.md README.md.bak");
macros.exec("cat README.md.bak | markmac > README.md");
macros.exec("rm README.md.bak");
project.postCompileTask.spawn(macros);

new JsonFile(project, ".markdownlint.json", {
  obj: {
    default: true,
    "commands-show-output": false,
    "line-length": {
      line_length: 200,
    },
  },
});
project.npmignore.exclude("/.markdownlint.json");

project.vscode.launchConfiguration.addConfiguration({
  type: "pwa-node",
  request: "launch",
  name: "projen CLI",
  skipFiles: ["<node_internals>/**"],
  program: "${workspaceFolder}/lib/cli/index.js",
  outFiles: ["${workspaceFolder}/lib/**/*.js"],
});

project.github.mergify.addRule({
  name: "Label core contributions",
  actions: {
    label: {
      add: ["contribution/core"],
    },
  },
  conditions: ["author~=^(eladb|Chriscbr)$", "label!=contribution/core"],
});

project.gitpod.addCustomTask({
  name: "Setup",
  init: "yarn install",
  prebuild: "bash ./projen.bash",
  command: "npx projen build",
});

const setup = project.addTask("devenv:setup");
setup.exec("yarn install");
setup.spawn(project.buildTask);
project.devContainer.addTasks(setup);
project.npmignore.exclude("/.devcontainer.json");

project.addTask("contributors:update", {
  exec: 'all-contributors check | grep "Missing contributors" -A 1 | tail -n1 | sed -e "s/,//g" | xargs -n1 | grep -v "\\[bot\\]" | grep -v "cdklabs-automation" | xargs -n1 -I{} all-contributors add {} code',
});
project.npmignore.exclude("/.all-contributorsrc");

project.npmignore.exclude("/docs/");
project.npmignore.exclude("/logo/");
project.npmignore.exclude("/rfcs/");
project.npmignore.exclude("/scripts/");
project.npmignore.exclude("/ARCHITECTURE.md");
project.npmignore.exclude("/CODE_OF_CONDUCT.md");
project.npmignore.exclude("/CONTRIBUTING.md");
project.npmignore.exclude("/VISION.md");
project.npmignore.exclude("/SECURITY.md");
project.npmignore.exclude("/.gitattributes");
project.npmignore.exclude("/.gitpod.yml");
project.npmignore.exclude("/.prettierignore");
project.npmignore.exclude("/.prettierrc.json");

function setupIntegTest() {
  const pythonCompatTask = project.addTask("integ:python-compat", {
    exec: "scripts/python-compat.sh",
    description:
      "Checks that projen's submodule structure does not cause import failures for python. Expects python to be installed and projen to be fully built.",
  });
  const integTask = project.addTask("integ", {
    description: "Run integration tests",
  });
  integTask.spawn(project.compileTask);
  integTask.spawn(project.tasks.tryFind("package:python"));
  integTask.spawn(pythonCompatTask);

  project.buildWorkflow.addPostBuildJobTask(integTask, {
    tools: { python: { version: "3.x" }, go: { version: "1.16.x" } },
  });
}

// build `run-task` script needed for "projen eject" functionality
function setupBundleTaskRunner() {
  const taskRunnerPath = "lib/run-task.js";
  const task = project.addTask("bundle:task-runner", {
    description: 'Bundle the run-task script needed for "projen eject"',
    exec: `esbuild src/task-runtime.ts --outfile=${taskRunnerPath} --bundle --platform=node --external:"*/package.json"`,
  });
  task.exec(
    `echo "#!/usr/bin/env node" | cat - lib/run-task.js | tee lib/run-task.js > /dev/null`,
    {
      name: "Insert Node shebang to beginning of the file",
    }
  );
  task.exec(
    `echo "const runtime = new TaskRuntime(\\".\\");\nruntime.runTask(process.argv[2]);" >> ${taskRunnerPath}`,
    {
      name: "Add driver code to end of the file",
    }
  );
  project.postCompileTask.spawn(task);
}

setupIntegTest();
setupBundleTaskRunner();

// we are projen, so re-synth after compiling.
// fixes feedback loop where projen contibutors run "build"
// but not all files are updated
project.postCompileTask.spawn(project.defaultTask);

new ProjectTree(project);

project.synth();