Documentation
¶
Index ¶
- func Names(list map[string]*SampleData) []string
- type SampleData
- type SampleList
- type Samples
- func (s *Samples) Cleanup(name string) error
- func (s *Samples) ConfigureDotEnv(sampleLocation string) error
- func (s *Samples) Copy(target string) error
- func (s *Samples) DeleteCache(sample string) error
- func (s *Samples) GetFiles(path string) ([]string, error)
- func (s *Samples) GetFolders(path string) ([]string, error)
- func (s *Samples) GetSamples(mode string) map[string]*SampleData
- func (s *Samples) Initialize(app string) error
- func (s *Samples) MakeFolder(name string) (string, error)
- func (s *Samples) PostInstall() string
- func (s *Samples) SelectOptions() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Names ¶
func Names(list map[string]*SampleData) []string
Names returns a list of all the sample's names
Types ¶
type SampleData ¶
type SampleData struct {
Name string `json:"name"`
URL string `json:"URL"`
Description string `json:"description"`
}
SampleData stores the information needed for Stripe Samples to operate in the CLI
func (*SampleData) BoldName ¶
func (sd *SampleData) BoldName() string
BoldName returns an ansi bold string for the name
func (*SampleData) GitRepo ¶
func (sd *SampleData) GitRepo() string
GitRepo returns a string of the repo with the .git prefix
type SampleList ¶ added in v1.3.9
type SampleList struct {
Samples []SampleData `json:"samples"`
}
SampleList is used to unmarshal the samples array from the JSON response
type Samples ¶
type Samples struct {
Config *config.Config
Fs afero.Fs
Git g.Interface
// contains filtered or unexported fields
}
Samples stores the information for the selected sample in addition to the selected configuration option to copy over
func (*Samples) ConfigureDotEnv ¶
ConfigureDotEnv takes the .env.example from the provided location and modifies it to automatically configure it for the users settings
func (*Samples) Copy ¶
Copy will copy all of the files from the selected configuration above oves. This has a few different behaviors, depending on the configuration. Ultimately, we want the user to do as minimal of folder traversing as possible. What we want to end up with is:
|- example-sample/ +-- client/ +-- server/ +-- readme.md +-- ... `-- .env.example
The behavior here is:
- If there are no integrations available, copy the top-level files, the client folder, and the selected language inside of the server folder to the server top-level (example above)
- If the user selects an integration, mirror the structure above for the selected integration (example above)
func (*Samples) DeleteCache ¶ added in v1.2.3
DeleteCache forces the local sample cache to refresh in case something goes awry during the initial clone or to clean out stale samples
func (*Samples) GetFolders ¶
GetFolders returns a list of all folders for a given path
func (*Samples) GetSamples ¶ added in v1.3.9
func (s *Samples) GetSamples(mode string) map[string]*SampleData
GetSamples returns a list that contains a mapping of Stripe Samples that we want to be available in the CLI to some of their metadata. TODO: what do we want to name these for it to be easier for users to select? TODO: should we group them by products for easier exploring?
func (*Samples) Initialize ¶
Initialize get the sample ready for the user to copy. It: 1. creates the sample cache folder if it doesn't exist 2. store the path of the locale cache folder for later use 3. if the selected app does not exist in the local cache folder, clone it 4. if the selected app does exist in the local cache folder, pull changes 5. parse the sample cli config file
func (*Samples) MakeFolder ¶
MakeFolder creates the folder that'll contain the Stripe app the user is creating
func (*Samples) PostInstall ¶ added in v0.8.4
PostInstall returns any installation for post installation instructions
func (*Samples) SelectOptions ¶
SelectOptions prompts the user to select the integration they want to use (if available) and the language they want the integration to be.
Source Files