Document tsconfig File for Plop Usage in TS

How to reproduce

yarn install plop
Create a perfectly valid plopfile.ts:


import { NodePlopAPI, AddActionConfig } from 'plop';

export default function generator(plop: NodePlopAPI): void {
  ...
}

yarn run plop

Expected behavior

plop prints a user prompt, generates files

Actual behavior

$ plop
/src/plopfile.ts:1
import { NodePlopAPI, AddActionConfig } from 'plop';
^^^^^^

SyntaxError: Cannot use import statement outside a module

Versions

Node version: 12.3.0 Plop version: 2.5.3

Issue Analytics

State:
Created 4 years ago
Reactions:6
Comments:29 (16 by maintainers)

Top GitHub Comments

30reactions

Vanuancommented, Dec 18, 2019

Renamed to plopfile.js and removes TS syntax.

12reactions

danielfigueiredocommented, Mar 15, 2022

I followed all instructions here and also what is in the example FDiskas linked but I keep getting the same error no matter what Even if I run plop via ts-node which should be able to parse ts files I get this same error. My entire monorepo project only has TS packages and no JS at all, unfortunately, plop isn’t there yet to work well with TS and even after tossing a few hours on it, I couldn’t get it to work, so declaring bankruptcy on getting plopfile.ts to work.

[PLOP] Something went wrong with reading your plop file TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".ts" for /Users/dan/Projects/design-system/plopfile.ts
    at new NodeError (node:internal/errors:370:5)
    at Loader.defaultGetFormat [as _getFormat] (node:internal/modules/esm/get_format:71:15)
    at Loader.getFormat (node:internal/modules/esm/loader:105:42)
    at Loader.getModuleJob (node:internal/modules/esm/loader:243:31)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Loader.import (node:internal/modules/esm/loader:177:17)
    at async nodePlop (file:///Users/dan/Projects/design-system/node_modules/node-plop/src/node-plop.js:198:26)
    at async Liftoff.run (file:///Users/dan/Projects/design-system/node_modules/plop/src/plop.js:56:12) {
  code: 'ERR_UNKNOWN_FILE_EXTENSION'
}

☝️ this error keeps being thrown no matter what I’ve added the "module": "commonjs" config to my tsconfig.json Using latest plop version "plop": "^3.0.5", and also using latest "ts-node": "^10.7.0",

🤷

Either way, I just wanted to say that this lib is great regardless so thanks for maintaining it