Indexer: Rename index to createIndex

[JReinhold]

What I did

This PR renames the index property on an indexer to indexFn createIndex for multiple reasons:

• index is a very generic term that can mean a lot of things in different contexts.
• This was based on input from @kylegach and @integrayshaun

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

[shilman]

I don't love it, but I'm fine with it if that's the consensus.

What about indexFile instead? We generally don't use the Fn suffix in Storybook. For example, stories provide a render function instead of a renderFn, etc.

[JReinhold]

I don't love it, but I'm fine with it if that's the consensus.

What about indexFile instead? We generally don't use the Fn suffix in Storybook. For example, stories provide a render function instead of a renderFn, etc.

I agree about the Fn suffix, its only purpose is to describe that this is not "an index" but "something that indexes". I'm happy to explore other names.

I don't like indexFile because it can easily be confused with the noun "an index file" rather than the verb "something that indexes a file" - in fact that was my initial reaction to your message.

Basically what we want to convey is "a function that takes in a file path and converts it to inputs to an index".

Are any of these better you think?

• indexBuilder
• buildIndex
• toIndex

Personally I like indexFn the best, but it's not a strong feeling.

[tmeasday]

I don't have a strong opinion but I think @shilman is right that we generally use verbs not nouns for function names 🤷

So of these:

indexBuilder
buildIndex
toIndex

Only buildIndex would fit. I get that it's confusing that "index" is both a verb and a noun. However in this case the function doesn't build the index, it just indexes a single file. So indexFile actually makes a lot of sense 🦆 .

[shilman]

I could also go with createIndex @JReinhold