-
Notifications
You must be signed in to change notification settings - Fork 229
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
9693 lint flow #9726
9693 lint flow #9726
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nice!
import { orchestrationFns } from './sendAnywhereFlows.js'; | ||
import * as flows from './sendAnywhere.flows.js'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
const orchFns = orchestrateAll(orchestrationFns, { | ||
const orchFns = orchestrateAll(flows, { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: git is not catching this as a rename. Could you split this commit in 2 with minimal changes to the source during the file rename?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
because you want to preserve the git blame on the lines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, but I'll say it didn't seem worth the time to me. the reindenting already touches all the lines.
@@ -35,6 +35,7 @@ import { preparePortfolioHolder } from '../exos/portfolio-holder-kit.js'; | |||
*/ | |||
|
|||
/** | |||
* @satisfies {OrchestrationFlow} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
@@ -0,0 +1,24 @@ | |||
/** | |||
* @file Module with linting errors, to verify the linting config detects them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👏
@@ -3,3 +3,18 @@ | |||
Build feature-rich applications that can orchestrate assets and services across the interchain. | |||
|
|||
Usage examples can be found under [src/examples](https://github.com/Agoric/agoric-sdk/tree/master/packages/orchestration/src/examples). They are exported for integration testing with other packages. | |||
|
|||
## Orchestration flows |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
only skimmed this
Refs: Agoric/agoric-sdk#9726 ## Description A new lint rule, `harden-exports`, to support Agoric/agoric-sdk#9726 Includes an autofixer ### Security Considerations Could enhance security ### Scaling Considerations n/a ### Documentation Considerations We don't yet document provided rules: https://endojs.github.io/endo/modules/_endo_eslint_plugin.html I think that's okay for now. If that is requested I'd file it as a separate issue, out of scope of this one. ### Testing Considerations I temporarily enabled this in the **recommended** config and ran `lint-fix` on the repo. All the changes looked correct. However `harden()` isn't always available so I don't think we should enable it in any of Endo's shared configs. ### Compatibility Considerations n/a ### Upgrade Considerations n/a
closes: #9692, #9693
Description
Sets up a convention for
flows
modules and document in the orchestration README.Also makes lint config to test them. The lint config is exported as a shared config that developers can use. I've included it in the same PR to make sure it works with the new convention.
Security Considerations
none
Scaling Considerations
none
Documentation Considerations
Documented the convention in the README. I expect it'll make its way to docs.agoric.com as needed.
Testing Considerations
nothing special
Upgrade Considerations
not yet deployed