friggframework / frigg Goto Github PK

ReferenceError: strKey is not defined
at get (/Users/jon/Code/lefthook/canva--frigg/backend/.webpack/service/src/handlers/http/webpack:/frigg-app-back-end/node_modules/@friggframework/assertions/get.js:17:1)

asertions/get.js

const get = (o, key, defaultValue) => {
    const value = lodashGet(o, key, defaultValue);

    if (value !== undefined) {
        return value;
    }

    if (defaultValue === undefined) {
        throw new RequiredPropertyError({
            parent: this,
            key: strKey,
        });
    }

    return defaultValue;
};

strKey is not declared in this method. You only see this error on run so maybe I am the first one to hit it.

Hey guys. This could be a really really useful project for the open source world. People need to work on it. :)

I think the best way to work in the open source world is through a strongly typed language. There are many reasons for this including:

• Forcing new contributors to adhere to coding standards
• Enabling new developers to understand the code better
• Make test writing easier as the code will have to change to make it more SRP (Single responsibility principle)

Steps to accomplish this:

1. Cover 70% of the code with tests currently. This is a loose outline but in general, just make it work with tests in a CI/CD fashion.

• All tests must be written in .ts

2. Convert all files to .ts.
3. Create objects for everything 😃
4. Make sure all the tests still pass

Hey everyone!

We need help with documentation. Please run the code as suggested and make updates! Post any errors in this thread and we will try to figure them out as we write better docs ourselves

If you want to work on docs? Thanks! We really appreciate it!

Things that need specific focus:

• Onboarding new users in the docs
• Explaining how to make a new module
• Explaining how to implement all modules
• Documentation in the code with explanation of decisions

Goals

• Documentation is easy to consume
• All docs live in the same place

I think this process could be improved and we can convert this into a doc once all the ideas and information are organized.

The goal

• Make development practices easy to understand
• Make onboarding less painful
• Provide a learning path to get people up to speed
• Provide pair sessions regularly
• Architecture overview and ongoing chats

Docs to read in order

• Frigg Overview: Key Concepts and Considerations (Updated August 2022)