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.

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

feat: use projen native TextFile features for generated files #281

Merged
merged 12 commits into from
Jan 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions .projen/deps.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions .projen/tasks.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions .projenrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const project = new TaimosTypescriptLibrary({
'axios',
'uuid',
'lambda-log',
'constructs',
],
defaultReleaseBranch: 'main',
minMajorVersion: '2',
Expand All @@ -24,13 +25,13 @@ const project = new TaimosTypescriptLibrary({
'@types/jwk-to-pem',
'@types/uuid',
'@hapi/boom',
'[email protected]',
],
peerDeps: [
'openapi-typescript',
'dynamodb-onetable',
'aws-cdk-lib@^2.60.0',
'@aws-cdk/aws-cognito-identitypool-alpha@^2.60.0-alpha.0',
'constructs@^10.0.5',
],
keywords: [
'aws',
Expand All @@ -51,8 +52,6 @@ const project = new TaimosTypescriptLibrary({
},
});

project.addDevDeps('typedoc');

const docgen = project.addTask('docgen', {
description: 'Generate TypeScript API reference',
exec: `typedoc ${project.srcdir}/constructs --disableSources --out ${project.docsDirectory}constructs/`,
Expand Down
7 changes: 3 additions & 4 deletions docs/constructs/assets/main.js

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/constructs/assets/navigation.js

This file was deleted.

2 changes: 1 addition & 1 deletion docs/constructs/assets/search.js

Large diffs are not rendered by default.

71 changes: 18 additions & 53 deletions docs/constructs/assets/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
--light-color-text-aside: #6e6e6e;
--light-color-link: #1f70c2;

--light-color-ts-keyword: #056bd6;
--light-color-ts-project: #b111c9;
--light-color-ts-module: var(--light-color-ts-project);
--light-color-ts-namespace: var(--light-color-ts-project);
Expand All @@ -29,7 +28,7 @@
--light-color-ts-constructor-signature: var(--light-color-ts-constructor);
--light-color-ts-parameter: var(--light-color-ts-variable);
/* type literal not included as links will never be generated to it */
--light-color-ts-type-parameter: #a55c0e;
--light-color-ts-type-parameter: var(--light-color-ts-type-alias);
--light-color-ts-accessor: var(--light-color-ts-property);
--light-color-ts-get-signature: var(--light-color-ts-accessor);
--light-color-ts-set-signature: var(--light-color-ts-accessor);
Expand All @@ -51,7 +50,6 @@
--dark-color-text-aside: #dddddd;
--dark-color-link: #00aff4;

--dark-color-ts-keyword: #3399ff;
--dark-color-ts-project: #e358ff;
--dark-color-ts-module: var(--dark-color-ts-project);
--dark-color-ts-namespace: var(--dark-color-ts-project);
Expand All @@ -69,7 +67,7 @@
--dark-color-ts-constructor-signature: var(--dark-color-ts-constructor);
--dark-color-ts-parameter: var(--dark-color-ts-variable);
/* type literal not included as links will never be generated to it */
--dark-color-ts-type-parameter: #e07d13;
--dark-color-ts-type-parameter: var(--dark-color-ts-type-alias);
--dark-color-ts-accessor: var(--dark-color-ts-property);
--dark-color-ts-get-signature: var(--dark-color-ts-accessor);
--dark-color-ts-set-signature: var(--dark-color-ts-accessor);
Expand All @@ -93,7 +91,6 @@
--color-text-aside: var(--light-color-text-aside);
--color-link: var(--light-color-link);

--color-ts-keyword: var(--light-color-ts-keyword);
--color-ts-module: var(--light-color-ts-module);
--color-ts-namespace: var(--light-color-ts-namespace);
--color-ts-enum: var(--light-color-ts-enum);
Expand Down Expand Up @@ -135,7 +132,6 @@
--color-text-aside: var(--dark-color-text-aside);
--color-link: var(--dark-color-link);

--color-ts-keyword: var(--dark-color-ts-keyword);
--color-ts-module: var(--dark-color-ts-module);
--color-ts-namespace: var(--dark-color-ts-namespace);
--color-ts-enum: var(--dark-color-ts-enum);
Expand Down Expand Up @@ -184,7 +180,6 @@ body {
--color-text-aside: var(--light-color-text-aside);
--color-link: var(--light-color-link);

--color-ts-keyword: var(--light-color-ts-keyword);
--color-ts-module: var(--light-color-ts-module);
--color-ts-namespace: var(--light-color-ts-namespace);
--color-ts-enum: var(--light-color-ts-enum);
Expand Down Expand Up @@ -224,7 +219,6 @@ body {
--color-text-aside: var(--dark-color-text-aside);
--color-link: var(--dark-color-link);

--color-ts-keyword: var(--dark-color-ts-keyword);
--color-ts-module: var(--dark-color-ts-module);
--color-ts-namespace: var(--dark-color-ts-namespace);
--color-ts-enum: var(--dark-color-ts-enum);
Expand Down Expand Up @@ -266,12 +260,12 @@ h6 {
line-height: 1.2;
}

h1 > a:not(.link),
h2 > a:not(.link),
h3 > a:not(.link),
h4 > a:not(.link),
h5 > a:not(.link),
h6 > a:not(.link) {
h1 > a,
h2 > a,
h3 > a,
h4 > a,
h5 > a,
h6 > a {
text-decoration: none;
color: var(--color-text);
}
Expand Down Expand Up @@ -649,28 +643,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
font-weight: bold;
}

.tsd-full-hierarchy:not(:last-child) {
margin-bottom: 1em;
padding-bottom: 1em;
border-bottom: 1px solid var(--color-accent);
}
.tsd-full-hierarchy,
.tsd-full-hierarchy ul {
list-style: none;
margin: 0;
padding: 0;
}
.tsd-full-hierarchy ul {
padding-left: 1.5rem;
}
.tsd-full-hierarchy a {
padding: 0.25rem 0 !important;
font-size: 1rem;
display: inline-flex;
align-items: center;
color: var(--color-text);
}

.tsd-panel-group.tsd-index-group {
margin-bottom: 0;
}
Expand Down Expand Up @@ -736,15 +708,12 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
}
.tsd-navigation > a,
.tsd-navigation .tsd-accordion-summary {
width: calc(100% - 0.25rem);
display: flex;
align-items: center;
width: calc(100% - 0.5rem);
}
.tsd-navigation a,
.tsd-navigation summary > span,
.tsd-page-navigation a {
display: flex;
width: calc(100% - 0.25rem);
display: inline-flex;
align-items: center;
padding: 0.25rem;
color: var(--color-text);
Expand Down Expand Up @@ -784,6 +753,11 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
margin-left: -1.5rem;
}

.tsd-nested-navigation > li > a,
.tsd-nested-navigation > li > span {
width: calc(100% - 1.75rem - 0.5rem);
}

.tsd-page-navigation ul {
padding-left: 1.75rem;
}
Expand Down Expand Up @@ -936,9 +910,8 @@ a.tsd-index-link {
box-shadow: 0 0 4px rgba(0, 0, 0, 0.25);
}
#tsd-search .results li {
padding: 0 10px;
background-color: var(--color-background);
line-height: initial;
padding: 4px;
}
#tsd-search .results li:nth-child(even) {
background-color: var(--color-background-secondary);
Expand All @@ -951,10 +924,7 @@ a.tsd-index-link {
background-color: var(--color-accent);
}
#tsd-search .results a {
display: flex;
align-items: center;
padding: 0.25rem;
box-sizing: border-box;
display: block;
}
#tsd-search .results a:before {
top: 10px;
Expand Down Expand Up @@ -1010,11 +980,6 @@ a.tsd-index-link {
overflow-x: auto;
}

.tsd-signature-keyword {
color: var(--color-ts-keyword);
font-weight: normal;
}

.tsd-signature-symbol {
color: var(--color-text-aside);
font-weight: normal;
Expand Down Expand Up @@ -1169,7 +1134,7 @@ img {
}

.deprecated {
text-decoration: line-through !important;
text-decoration: line-through;
}

.warning {
Expand Down
Loading