@skeptools/skep-organization-project 0.0.0 → 0.0.1

package/.jsii

@@ -78,7 +78,7 @@
   },
   "name": "@skeptools/skep-organization-project",
   "readme": {
-    "markdown": "# skep-organization-project\n\n## Bootstrapping\n1. Set a `NPM_TOKEN` secret at either the repository or org level. It needs to have permissions to write packages.\n2. Set a `PROJEN_GITHUB_TOKEN` secret at either the repository or org level. It needs to have permissions to submit PRs.\n3. Add template files into the `files/generated` or `files/scaffolding` directories as needed. See [reference](https://github.com/rlmartin-projen/projen-project#adding-simple-template-files) if needed.\n4. Add non-templated resources to `src/skep-organization-project.ts`\n5. Delete this section of the README\n"
+    "markdown": "# skep-organization-project\n\n## Usage\n```\nnpx projen new \\\n  --from @skeptools/skep-organization-project \\\n  --organization-name \"Foo Company\" \\\n  --projenrcts\n```\n"
   },
   "repository": {
     "type": "git",
@@ -93,7 +93,7 @@
   "types": {
     "@skeptools/skep-organization-project.SkepOrganizationProject": {
       "assembly": "@skeptools/skep-organization-project",
-      "base": "projen.cdk.JsiiProject",
+      "base": "projen.typescript.TypeScriptProject",
       "docs": {
         "stability": "stable"
       },
@@ -131,7 +131,7 @@
       },
       "fqn": "@skeptools/skep-organization-project.SkepOrganizationProjectOptions",
       "interfaces": [
-        "projen.cdk.JsiiProjectOptions"
+        "projen.typescript.TypeScriptProjectOptions"
       ],
       "kind": "interface",
       "locationInModule": {
@@ -159,6 +159,6 @@
       "symbolId": "src/skep-organization-project:SkepOrganizationProjectOptions"
     }
   },
-  "version": "0.0.0",
-  "fingerprint": "joxEDyMZzC3zcCZMEkLZk4l/qv9OI7mm6M/ewWfVStM="
+  "version": "0.0.1",
+  "fingerprint": "f4L/K/RWNLF4+yYnuABhfAZGtOzy+jsRW4eJAsDHaPw="
 }

package/API.md

@@ -149,21 +149,6 @@ const skepOrganizationProjectOptions: SkepOrganizationProjectOptions = { ... }
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfigDev">tsconfigDev</a></code> | <code>projen.javascript.TypescriptConfigOptions</code> | Custom tsconfig options for the development tsconfig.json file (used for testing). |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.tsconfigDevFile">tsconfigDevFile</a></code> | <code>string</code> | The name of the development tsconfig.json file. |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.typescriptVersion">typescriptVersion</a></code> | <code>string</code> | TypeScript version to use. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.author">author</a></code> | <code>string</code> | The name of the library author. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorAddress">authorAddress</a></code> | <code>string</code> | Email or URL of the library author. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repositoryUrl">repositoryUrl</a></code> | <code>string</code> | Git repository URL. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compat">compat</a></code> | <code>boolean</code> | Automatically run API compatibility test against the latest version published to npm after compilation. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compatIgnore">compatIgnore</a></code> | <code>string</code> | Name of the ignore file for API compatibility tests. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compressAssembly">compressAssembly</a></code> | <code>boolean</code> | Emit a compressed version of the assembly. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docgenFilePath">docgenFilePath</a></code> | <code>string</code> | File path for generated docs. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.dotnet">dotnet</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | *No description.* |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.excludeTypescript">excludeTypescript</a></code> | <code>string[]</code> | Accepts a list of glob patterns. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToGo">publishToGo</a></code> | <code>projen.cdk.JsiiGoTarget</code> | Publish Go bindings to a git repository. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToMaven">publishToMaven</a></code> | <code>projen.cdk.JsiiJavaTarget</code> | Publish to maven. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToNuget">publishToNuget</a></code> | <code>projen.cdk.JsiiDotNetTarget</code> | Publish to NuGet. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToPypi">publishToPypi</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | Publish to pypi. |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.python">python</a></code> | <code>projen.cdk.JsiiPythonTarget</code> | *No description.* |
-| <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.rootdir">rootdir</a></code> | <code>string</code> | *No description.* |
 | <code><a href="#@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.organizationName">organizationName</a></code> | <code>string</code> | *No description.* |
 
 ---
@@ -2045,205 +2030,6 @@ same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`).
 
 ---
 
-##### `author`<sup>Required</sup> <a name="author" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.author"></a>
-
-```typescript
-public readonly author: string;
-```
-
-- *Type:* string
-- *Default:* $GIT_USER_NAME
-
-The name of the library author.
-
----
-
-##### `authorAddress`<sup>Required</sup> <a name="authorAddress" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.authorAddress"></a>
-
-```typescript
-public readonly authorAddress: string;
-```
-
-- *Type:* string
-- *Default:* $GIT_USER_EMAIL
-
-Email or URL of the library author.
-
----
-
-##### `repositoryUrl`<sup>Required</sup> <a name="repositoryUrl" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.repositoryUrl"></a>
-
-```typescript
-public readonly repositoryUrl: string;
-```
-
-- *Type:* string
-- *Default:* $GIT_REMOTE
-
-Git repository URL.
-
----
-
-##### `compat`<sup>Optional</sup> <a name="compat" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compat"></a>
-
-```typescript
-public readonly compat: boolean;
-```
-
-- *Type:* boolean
-- *Default:* false
-
-Automatically run API compatibility test against the latest version published to npm after compilation.
-
-You can manually run compatibility tests using `yarn compat` if this feature is disabled.
-- You can ignore compatibility failures by adding lines to a ".compatignore" file.
-
----
-
-##### `compatIgnore`<sup>Optional</sup> <a name="compatIgnore" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compatIgnore"></a>
-
-```typescript
-public readonly compatIgnore: string;
-```
-
-- *Type:* string
-- *Default:* ".compatignore"
-
-Name of the ignore file for API compatibility tests.
-
----
-
-##### `compressAssembly`<sup>Optional</sup> <a name="compressAssembly" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.compressAssembly"></a>
-
-```typescript
-public readonly compressAssembly: boolean;
-```
-
-- *Type:* boolean
-- *Default:* false
-
-Emit a compressed version of the assembly.
-
----
-
-##### `docgenFilePath`<sup>Optional</sup> <a name="docgenFilePath" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.docgenFilePath"></a>
-
-```typescript
-public readonly docgenFilePath: string;
-```
-
-- *Type:* string
-- *Default:* "API.md"
-
-File path for generated docs.
-
----
-
-##### ~~`dotnet`~~<sup>Optional</sup> <a name="dotnet" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.dotnet"></a>
-
-- *Deprecated:* use `publishToNuget`
-
-```typescript
-public readonly dotnet: JsiiDotNetTarget;
-```
-
-- *Type:* projen.cdk.JsiiDotNetTarget
-
----
-
-##### `excludeTypescript`<sup>Optional</sup> <a name="excludeTypescript" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.excludeTypescript"></a>
-
-```typescript
-public readonly excludeTypescript: string[];
-```
-
-- *Type:* string[]
-
-Accepts a list of glob patterns.
-
-Files matching any of those patterns will be excluded from the TypeScript compiler input.
-
-By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input.
-This can be problematic for example when the package's build or test procedure generates .ts files
-that cannot be compiled with jsii's compiler settings.
-
----
-
-##### `publishToGo`<sup>Optional</sup> <a name="publishToGo" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToGo"></a>
-
-```typescript
-public readonly publishToGo: JsiiGoTarget;
-```
-
-- *Type:* projen.cdk.JsiiGoTarget
-- *Default:* no publishing
-
-Publish Go bindings to a git repository.
-
----
-
-##### `publishToMaven`<sup>Optional</sup> <a name="publishToMaven" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToMaven"></a>
-
-```typescript
-public readonly publishToMaven: JsiiJavaTarget;
-```
-
-- *Type:* projen.cdk.JsiiJavaTarget
-- *Default:* no publishing
-
-Publish to maven.
-
----
-
-##### `publishToNuget`<sup>Optional</sup> <a name="publishToNuget" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToNuget"></a>
-
-```typescript
-public readonly publishToNuget: JsiiDotNetTarget;
-```
-
-- *Type:* projen.cdk.JsiiDotNetTarget
-- *Default:* no publishing
-
-Publish to NuGet.
-
----
-
-##### `publishToPypi`<sup>Optional</sup> <a name="publishToPypi" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.publishToPypi"></a>
-
-```typescript
-public readonly publishToPypi: JsiiPythonTarget;
-```
-
-- *Type:* projen.cdk.JsiiPythonTarget
-- *Default:* no publishing
-
-Publish to pypi.
-
----
-
-##### ~~`python`~~<sup>Optional</sup> <a name="python" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.python"></a>
-
-- *Deprecated:* use `publishToPyPi`
-
-```typescript
-public readonly python: JsiiPythonTarget;
-```
-
-- *Type:* projen.cdk.JsiiPythonTarget
-
----
-
-##### `rootdir`<sup>Optional</sup> <a name="rootdir" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.rootdir"></a>
-
-```typescript
-public readonly rootdir: string;
-```
-
-- *Type:* string
-- *Default:* "."
-
----
-
 ##### `organizationName`<sup>Required</sup> <a name="organizationName" id="@skeptools/skep-organization-project.SkepOrganizationProjectOptions.property.organizationName"></a>
 
 ```typescript

package/README.md

@@ -1,8 +1,9 @@
 # skep-organization-project
 
-## Bootstrapping
-1. Set a `NPM_TOKEN` secret at either the repository or org level. It needs to have permissions to write packages.
-2. Set a `PROJEN_GITHUB_TOKEN` secret at either the repository or org level. It needs to have permissions to submit PRs.
-3. Add template files into the `files/generated` or `files/scaffolding` directories as needed. See [reference](https://github.com/rlmartin-projen/projen-project#adding-simple-template-files) if needed.
-4. Add non-templated resources to `src/skep-organization-project.ts`
-5. Delete this section of the README
+## Usage
+```
+npx projen new \
+  --from @skeptools/skep-organization-project \
+  --organization-name "Foo Company" \
+  --projenrcts
+```

package/lib/skep-organization-project.d.ts

@@ -1,7 +1,7 @@
-import { cdk } from 'projen';
-export interface SkepOrganizationProjectOptions extends cdk.JsiiProjectOptions {
+import { typescript } from 'projen';
+export interface SkepOrganizationProjectOptions extends typescript.TypeScriptProjectOptions {
     readonly organizationName: string;
 }
-export declare class SkepOrganizationProject extends cdk.JsiiProject {
+export declare class SkepOrganizationProject extends typescript.TypeScriptProject {
     constructor(options: SkepOrganizationProjectOptions);
 }

package/lib/skep-organization-project.js

@@ -6,7 +6,7 @@ const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
 const path = require("path");
 const projen_project_1 = require("@rlmartin-projen/projen-project");
 const projen_1 = require("projen");
-class SkepOrganizationProject extends projen_1.cdk.JsiiProject {
+class SkepOrganizationProject extends projen_1.typescript.TypeScriptProject {
     constructor(options) {
         const tempOptions = {
             ...options,
@@ -20,5 +20,5 @@ class SkepOrganizationProject extends projen_1.cdk.JsiiProject {
 }
 exports.SkepOrganizationProject = SkepOrganizationProject;
 _a = JSII_RTTI_SYMBOL_1;
-SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.0" };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2tlcC1vcmdhbml6YXRpb24tcHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9za2VwLW9yZ2FuaXphdGlvbi1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBQzdCLG9FQUFtRjtBQUNuRixtQ0FBNkI7QUFNN0IsTUFBYSx1QkFBd0IsU0FBUSxZQUFHLENBQUMsV0FBVztJQUMxRCxZQUFZLE9BQXVDO1FBQ2pELE1BQU0sV0FBVyxHQUFHO1lBQ2xCLEdBQUcsT0FBTztZQUNWLGlCQUFpQixFQUFFLHlCQUFRLENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDO1NBQ3RELENBQUM7UUFDRixNQUFNLEVBQUUsT0FBTyxFQUFFLFdBQVcsRUFBRSxLQUFLLEVBQUUsR0FBRyw2QkFBWSxDQUFDLFdBQVcsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxVQUFVLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxRyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDbkIseUJBQVEsQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDdEIsbUNBQW1DO0lBQ3JDLENBQUM7O0FBVkgsMERBV0MiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgKiBhcyBwYXRoIGZyb20gJ3BhdGgnO1xuaW1wb3J0IHsgYWRkRmlsZXMsIGFsbENhc2VzLCBsb2FkU2V0dGluZ3MgfSBmcm9tICdAcmxtYXJ0aW4tcHJvamVuL3Byb2plbi1wcm9qZWN0JztcbmltcG9ydCB7IGNkayB9IGZyb20gJ3Byb2plbic7XG5cbmV4cG9ydCBpbnRlcmZhY2UgU2tlcE9yZ2FuaXphdGlvblByb2plY3RPcHRpb25zIGV4dGVuZHMgY2RrLkpzaWlQcm9qZWN0T3B0aW9ucyB7XG4gIHJlYWRvbmx5IG9yZ2FuaXphdGlvbk5hbWU6IHN0cmluZztcbn1cblxuZXhwb3J0IGNsYXNzIFNrZXBPcmdhbml6YXRpb25Qcm9qZWN0IGV4dGVuZHMgY2RrLkpzaWlQcm9qZWN0IHtcbiAgY29uc3RydWN0b3Iob3B0aW9uczogU2tlcE9yZ2FuaXphdGlvblByb2plY3RPcHRpb25zKSB7XG4gICAgY29uc3QgdGVtcE9wdGlvbnMgPSB7XG4gICAgICAuLi5vcHRpb25zLFxuICAgICAgX29yZ2FuaXphdGlvbk5hbWU6IGFsbENhc2VzKG9wdGlvbnMub3JnYW5pemF0aW9uTmFtZSksXG4gICAgfTtcbiAgICBjb25zdCB7IG9wdGlvbnM6IHByb2plY3RPcHRzLCBmaWxlcyB9ID0gbG9hZFNldHRpbmdzKHRlbXBPcHRpb25zLCBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vZmlsZXMnKSwgdHJ1ZSk7XG4gICAgc3VwZXIocHJvamVjdE9wdHMpO1xuICAgIGFkZEZpbGVzKHRoaXMsIGZpbGVzKTtcbiAgICAvLyBBZGQgbm9uLXRlbXBsYXRlZCByZXNvdXJjZXMgaGVyZVxuICB9XG59XG4iXX0=
+SkepOrganizationProject[_a] = { fqn: "@skeptools/skep-organization-project.SkepOrganizationProject", version: "0.0.1" };
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic2tlcC1vcmdhbml6YXRpb24tcHJvamVjdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9za2VwLW9yZ2FuaXphdGlvbi1wcm9qZWN0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsNkJBQTZCO0FBQzdCLG9FQUFtRjtBQUNuRixtQ0FBb0M7QUFNcEMsTUFBYSx1QkFBd0IsU0FBUSxtQkFBVSxDQUFDLGlCQUFpQjtJQUN2RSxZQUFZLE9BQXVDO1FBQ2pELE1BQU0sV0FBVyxHQUFHO1lBQ2xCLEdBQUcsT0FBTztZQUNWLGlCQUFpQixFQUFFLHlCQUFRLENBQUMsT0FBTyxDQUFDLGdCQUFnQixDQUFDO1NBQ3RELENBQUM7UUFDRixNQUFNLEVBQUUsT0FBTyxFQUFFLFdBQVcsRUFBRSxLQUFLLEVBQUUsR0FBRyw2QkFBWSxDQUFDLFdBQVcsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxVQUFVLENBQUMsRUFBRSxJQUFJLENBQUMsQ0FBQztRQUMxRyxLQUFLLENBQUMsV0FBVyxDQUFDLENBQUM7UUFDbkIseUJBQVEsQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLENBQUM7UUFDdEIsbUNBQW1DO0lBQ3JDLENBQUM7O0FBVkgsMERBV0MiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgKiBhcyBwYXRoIGZyb20gJ3BhdGgnO1xuaW1wb3J0IHsgYWRkRmlsZXMsIGFsbENhc2VzLCBsb2FkU2V0dGluZ3MgfSBmcm9tICdAcmxtYXJ0aW4tcHJvamVuL3Byb2plbi1wcm9qZWN0JztcbmltcG9ydCB7IHR5cGVzY3JpcHQgfSBmcm9tICdwcm9qZW4nO1xuXG5leHBvcnQgaW50ZXJmYWNlIFNrZXBPcmdhbml6YXRpb25Qcm9qZWN0T3B0aW9ucyBleHRlbmRzIHR5cGVzY3JpcHQuVHlwZVNjcmlwdFByb2plY3RPcHRpb25zIHtcbiAgcmVhZG9ubHkgb3JnYW5pemF0aW9uTmFtZTogc3RyaW5nO1xufVxuXG5leHBvcnQgY2xhc3MgU2tlcE9yZ2FuaXphdGlvblByb2plY3QgZXh0ZW5kcyB0eXBlc2NyaXB0LlR5cGVTY3JpcHRQcm9qZWN0IHtcbiAgY29uc3RydWN0b3Iob3B0aW9uczogU2tlcE9yZ2FuaXphdGlvblByb2plY3RPcHRpb25zKSB7XG4gICAgY29uc3QgdGVtcE9wdGlvbnMgPSB7XG4gICAgICAuLi5vcHRpb25zLFxuICAgICAgX29yZ2FuaXphdGlvbk5hbWU6IGFsbENhc2VzKG9wdGlvbnMub3JnYW5pemF0aW9uTmFtZSksXG4gICAgfTtcbiAgICBjb25zdCB7IG9wdGlvbnM6IHByb2plY3RPcHRzLCBmaWxlcyB9ID0gbG9hZFNldHRpbmdzKHRlbXBPcHRpb25zLCBwYXRoLmpvaW4oX19kaXJuYW1lLCAnLi4vZmlsZXMnKSwgdHJ1ZSk7XG4gICAgc3VwZXIocHJvamVjdE9wdHMpO1xuICAgIGFkZEZpbGVzKHRoaXMsIGZpbGVzKTtcbiAgICAvLyBBZGQgbm9uLXRlbXBsYXRlZCByZXNvdXJjZXMgaGVyZVxuICB9XG59XG4iXX0=

package/package.json

@@ -74,7 +74,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.0.0",
+  "version": "0.0.1",
   "jest": {
     "testMatch": [
       "<rootDir>/src/**/__tests__/**/*.ts?(x)",