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: initial api #2

Merged
merged 28 commits into from
Aug 26, 2024
Merged

feat: initial api #2

merged 28 commits into from
Aug 26, 2024

Conversation

CptSchnitz
Copy link
Collaborator

This is first version without testing yet, the review should not be merged yet.

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-056bb14c634365027ee0e5c12f0812e00cd1e80c.tgz"
  }
}

The link will expire in a week ⌛

Copy link

@syncush syncush left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Some of the code has JSDoc and some doesn't, let's go all for JSDoc!
  2. Tests?

src/debug.ts Outdated
Comment on lines 1 to 5
import debug from 'debug';

export function createDebug(name: string): debug.Debugger {
return debug(`@map-colonies/config:${name}`);
}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not too fond of it being in the main files hierarchy

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved to util

src/constants.ts Outdated
import { readPackageJsonSync } from '@map-colonies/read-pkg';

const schemasPackagePathBuildPath = require.resolve('@map-colonies/schemas').substring(0, require.resolve('@map-colonies/schemas').indexOf('build'));
export const LOCAL_SCHEMAS_PACKAGE_VERSION = readPackageJsonSync(schemasPackagePathBuildPath + 'package.json').version as string;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we use path. join?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

joined

src/env.ts Outdated Show resolved Hide resolved
.vscode/settings.json Outdated Show resolved Hide resolved
src/env.ts Outdated Show resolved Hide resolved
src/options.ts Show resolved Hide resolved
src/debug.ts Outdated Show resolved Hide resolved
src/env.ts Outdated Show resolved Hide resolved
Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-50eb954f8e0403d61972d1b4bad05cb90ba29104.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-acc5f5f9caf010d2337792ccd56fb6857e507249.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-3706662a3d86a5b8b1571d2f4e1d34c139dd8e7f.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-d8a657aa1c994167a383307efbf7e468ebe50863.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-865c69e9aad168f114771062beebd0fd8e841620.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-71674559ed69428ea1bdc3914f98b287609d760a.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-fb883c3b9f92cb957a7cf33c6d1b4f0e94489aad.tgz"
  }
}

The link will expire in a week ⌛

Copy link

github-actions bot commented Jul 4, 2024

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-13c28def501490deb28d0687e3e91a908e113d1f.tgz"
  }
}

The link will expire in a week ⌛

Copy link

github-actions bot commented Jul 4, 2024

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-75a5af4ca302a434771cb9c79118e92975caacf0.tgz"
  }
}

The link will expire in a week ⌛

Copy link

github-actions bot commented Jul 7, 2024

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-f5318aa4e443db4c34344120287208d9195424d8.tgz"
  }
}

The link will expire in a week ⌛

Copy link

github-actions bot commented Jul 8, 2024

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-baacb7eef75640776137b101422c645bae76daed.tgz"
  }
}

The link will expire in a week ⌛

Copy link

github-actions bot commented Jul 9, 2024

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-0d61d0b759173e3bdc4baf4d852db38b7da041e7.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-41956f3cf7e0565a6c983bd74e74fcb605dc7775.tgz"
  }
}

The link will expire in a week ⌛

tests/config.spec.ts Outdated Show resolved Hide resolved
tests/validator.spec.ts Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-c770b2ebdfe4126e8e365a5113fe8b944ccaff6e.tgz"
  }
}

The link will expire in a week ⌛

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-b4afec5a00dc6b635e44cd34c493fd928f84ba8f.tgz"
  }
}

The link will expire in a week ⌛

@CptSchnitz CptSchnitz requested a review from netanelC July 25, 2024 08:39
@CptSchnitz CptSchnitz marked this pull request as ready for review July 30, 2024 05:40
@RonitKissis
Copy link

"localConfigPath" should be optional, it has a default value

Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-6b31439baecde35d4488e74569bfec3f2eafe7d8.tgz"
  }
}

The link will expire in a week ⌛

src/config.ts Outdated Show resolved Hide resolved
src/config.ts Outdated Show resolved Hide resolved
src/validator.ts Outdated Show resolved Hide resolved
Copy link

Hi it is me, your friendly bot helper! 👋
I've packed this commit for you 😊
You can install it like this:

{
  "dependencies": {
      "@map-colonies/config": "https://ghatmpstorage.blob.core.windows.net/npm-packages/config-1ad0a688e4fdb5b3b4e6e511c886d6088de5c6e7.tgz"
  }
}

The link will expire in a week ⌛

@CptSchnitz CptSchnitz merged commit 3d04ca0 into master Aug 26, 2024
5 checks passed
@CptSchnitz CptSchnitz deleted the initial-api branch August 26, 2024 06:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants